public interface

VideoControlService

implements IVCR
vars.shared.ui.video.VideoControlService
Known Indirect Subclasses

Summary

Public Methods
abstract void connect(Object... args)
Connect to your video controller.
abstract JDialog getConnectionDialog()
Connect to your video service with input from a User Interface.
abstract VideoControlInformation getVideoControlInformation()
Retrive information about the state of the connection
abstract boolean isConnected()
abstract boolean isPlaying()
abstract boolean isStopped()
abstract VideoTime requestVideoTime()
abstract void seek(String timecode)
Seek to the given timecode
[Expand]
Inherited Methods
From interface org.mbari.vcr.IVCR

Public Methods

public abstract void connect (Object... args)

Connect to your video controller. This method accepts a varargs as the argument so you can feed in whatever params you need.

Parameters
args The arguments need to connect to you video control service

public abstract JDialog getConnectionDialog ()

Connect to your video service with input from a User Interface. This method should implement the UI needed to collect the parameters, then call the connect method. The returned dialog may be requested once and then subsequently reused by UI components so you should write it accordely.

Returns
  • A JDialog that can be used to connect to your video service

public abstract VideoControlInformation getVideoControlInformation ()

Retrive information about the state of the connection

Returns
  • An object that encapsualtes the connection name and state.

public abstract boolean isConnected ()

Returns
  • true if the VideoControlService is connected. false if it is not connected.

public abstract boolean isPlaying ()

Returns
  • true If the video is playing. false if it is not playing (e.g. stopped, fast-forwarding, rewinding, etc.)

public abstract boolean isStopped ()

Returns
  • true if the video is stopped

public abstract VideoTime requestVideoTime ()

Returns
  • The current videotimeobject

public abstract void seek (String timecode)

Seek to the given timecode