Index
All Classes and Interfaces|All Packages|Constant Field Values
C
- checkArgument(boolean, String) - Static method in class org.mbari.vcr4j.util.Preconditions
- close() - Method in class org.mbari.vcr4j.decorators.SchedulerVideoIO
- close() - Method in class org.mbari.vcr4j.SimpleVideoIO
- close() - Method in interface org.mbari.vcr4j.VideoIO
-
Close the video io and free it's resources.
- CollectionUtils - Class in org.mbari.vcr4j.util
- CollectionUtils() - Constructor for class org.mbari.vcr4j.util.CollectionUtils
- commandSubscriber - Variable in class org.mbari.vcr4j.decorators.LoggingDecorator
- Converters - Class in org.mbari.vcr4j.time
- Converters() - Constructor for class org.mbari.vcr4j.time.Converters
D
- Decorator - Interface in org.mbari.vcr4j.decorators
-
For this project, Decorators are classes that manage a bundle of subscribers to VideoIO objects.
E
- EMPTY_TIMECODE_STRING - Static variable in class org.mbari.vcr4j.time.Timecode
- equals(Object) - Method in class org.mbari.vcr4j.util.Pair
- equals(Object) - Method in class org.mbari.vcr4j.VideoIndex
- errorSubscriber - Variable in class org.mbari.vcr4j.decorators.LoggingDecorator
F
- FAST_FORWARD - Enum constant in enum class org.mbari.vcr4j.commands.VideoCommands
- fastForward() - Method in class org.mbari.vcr4j.VideoController
- FrameRates - Class in org.mbari.vcr4j.time
-
Common framerates as frames/second
- FrameRates() - Constructor for class org.mbari.vcr4j.time.FrameRates
- from(double, double) - Static method in class org.mbari.vcr4j.time.HMSF
- from(String) - Static method in class org.mbari.vcr4j.time.HMSF
-
Build an HMSF from a timecode string ("HH:MM:SS::FF")
- fromSeconds(double, int) - Static method in class org.mbari.vcr4j.time.MediaTime
G
- getA() - Method in class org.mbari.vcr4j.util.Pair
- getB() - Method in class org.mbari.vcr4j.util.Pair
- getCommandSubject() - Method in class org.mbari.vcr4j.decorators.SchedulerVideoIO
- getCommandSubject() - Method in class org.mbari.vcr4j.SimpleVideoIO
- getCommandSubject() - Method in interface org.mbari.vcr4j.VideoIO
-
We foresee needing to chain several VideoIO services together.
- getConnectionID() - Method in class org.mbari.vcr4j.decorators.SchedulerVideoIO
- getConnectionID() - Method in class org.mbari.vcr4j.SimpleVideoIO
- getConnectionID() - Method in interface org.mbari.vcr4j.VideoIO
- getElapsedTime() - Method in class org.mbari.vcr4j.VideoIndex
- getErrorObservable() - Method in class org.mbari.vcr4j.decorators.SchedulerVideoIO
- getErrorObservable() - Method in class org.mbari.vcr4j.SimpleVideoIO
- getErrorObservable() - Method in class org.mbari.vcr4j.VideoController
- getErrorObservable() - Method in interface org.mbari.vcr4j.VideoIO
-
All errors that occur will be sent to this observable
- getFrame() - Method in class org.mbari.vcr4j.time.HMSF
- getFrameRate() - Method in class org.mbari.vcr4j.time.Timecode
- getFrames() - Method in class org.mbari.vcr4j.time.Timecode
- getHMSF() - Method in class org.mbari.vcr4j.time.Timecode
-
If the timecode is in a valid format then this will be present.
- getHour() - Method in class org.mbari.vcr4j.time.HMSF
- getIndexObservable() - Method in class org.mbari.vcr4j.decorators.SchedulerVideoIO
- getIndexObservable() - Method in class org.mbari.vcr4j.SimpleVideoIO
- getIndexObservable() - Method in class org.mbari.vcr4j.VideoController
- getIndexObservable() - Method in interface org.mbari.vcr4j.VideoIO
- getMinute() - Method in class org.mbari.vcr4j.time.HMSF
- getName() - Method in class org.mbari.vcr4j.commands.SimpleVideoCommand
- getName() - Method in enum class org.mbari.vcr4j.commands.VideoCommands
- getName() - Method in interface org.mbari.vcr4j.VideoCommand
- getSecond() - Method in class org.mbari.vcr4j.time.HMSF
- getSeconds() - Method in class org.mbari.vcr4j.time.MediaTime
- getSeconds() - Method in class org.mbari.vcr4j.time.Timecode
- getStateObservable() - Method in class org.mbari.vcr4j.decorators.SchedulerVideoIO
- getStateObservable() - Method in class org.mbari.vcr4j.SimpleVideoIO
- getStateObservable() - Method in class org.mbari.vcr4j.VideoController
- getStateObservable() - Method in interface org.mbari.vcr4j.VideoIO
-
Listen to this observable for responses to status requests
- getTimecode() - Method in class org.mbari.vcr4j.VideoIndex
- getTimer() - Method in class org.mbari.vcr4j.decorators.VCRSyncDecorator
- getTimer() - Method in class org.mbari.vcr4j.decorators.VideoSyncDecorator
- getTimescale() - Method in class org.mbari.vcr4j.time.MediaTime
- getTimestamp() - Method in class org.mbari.vcr4j.VideoIndex
- getTypeAt(int) - Method in class org.mbari.vcr4j.util.Pair
- getTypeAt(int) - Method in interface org.mbari.vcr4j.util.Tuple
- getValue() - Method in class org.mbari.vcr4j.commands.SimpleVideoCommand
- getValue() - Method in enum class org.mbari.vcr4j.commands.VideoCommands
- getValue() - Method in class org.mbari.vcr4j.time.MediaTime
- getValue() - Method in interface org.mbari.vcr4j.VideoCommand
- getValueAt(int) - Method in class org.mbari.vcr4j.util.Pair
- getValueAt(int) - Method in interface org.mbari.vcr4j.util.Tuple
- getVideoCommand() - Method in class org.mbari.vcr4j.SimpleVideoError
- getVideoCommand() - Method in interface org.mbari.vcr4j.VideoError
- getVideoIO() - Method in class org.mbari.vcr4j.VideoController
- grouped(List<T>, int) - Static method in class org.mbari.vcr4j.util.CollectionUtils
H
- hasError() - Method in class org.mbari.vcr4j.SimpleVideoError
- hasError() - Method in interface org.mbari.vcr4j.VideoError
- hashCode() - Method in class org.mbari.vcr4j.util.Pair
- hashCode() - Method in class org.mbari.vcr4j.VideoIndex
- HMSF - Class in org.mbari.vcr4j.time
-
HMSF is a container for hour, minute, second, frame as can be represented in a Timecode.
- HMSF(int, int, int, int) - Constructor for class org.mbari.vcr4j.time.HMSF
-
Default constructor
I
- indexSubscriber - Variable in class org.mbari.vcr4j.decorators.LoggingDecorator
- InjectVideoIndexCmd - Class in org.mbari.vcr4j.commands
-
Occasionally, we need to force a video index.
- InjectVideoIndexCmd(String, VideoIndex) - Constructor for class org.mbari.vcr4j.commands.InjectVideoIndexCmd
- intersection(Collection<T>, Collection<T>) - Static method in class org.mbari.vcr4j.util.CollectionUtils
- isComplete() - Method in class org.mbari.vcr4j.time.Timecode
- isConnected() - Method in interface org.mbari.vcr4j.VideoState
- isCueingUp() - Method in interface org.mbari.vcr4j.VideoState
- isFastForwarding() - Method in interface org.mbari.vcr4j.VideoState
- isPlaying() - Method in interface org.mbari.vcr4j.VideoState
- isReverseDirection() - Method in interface org.mbari.vcr4j.VideoState
- isRewinding() - Method in interface org.mbari.vcr4j.VideoState
- isRounded() - Method in class org.mbari.vcr4j.time.MediaTime
- isShuttling() - Method in interface org.mbari.vcr4j.VideoState
- isStopped() - Method in interface org.mbari.vcr4j.VideoState
- isValid() - Method in class org.mbari.vcr4j.time.Timecode
L
- log - Variable in class org.mbari.vcr4j.decorators.LoggingDecorator
- LoggingDecorator<S extends VideoState,
E extends VideoError> - Class in org.mbari.vcr4j.decorators -
Logs the errors, indices, state, and commands for a VideoIO
- LoggingDecorator(VideoIO<S, E>) - Constructor for class org.mbari.vcr4j.decorators.LoggingDecorator
M
- MediaTime - Class in org.mbari.vcr4j.time
-
Time modeled after Apple's CoreMedia CMTime.
- MediaTime(long, int) - Constructor for class org.mbari.vcr4j.time.MediaTime
- MediaTime(long, int, boolean) - Constructor for class org.mbari.vcr4j.time.MediaTime
-
For example to create a MediaTime that's 200 seconds into a video that has 29.97 frame rate use
new MediaTime(20000, 2997)
N
- NTSC - Static variable in class org.mbari.vcr4j.time.FrameRates
O
- org.mbari.vcr4j - package org.mbari.vcr4j
- org.mbari.vcr4j.commands - package org.mbari.vcr4j.commands
- org.mbari.vcr4j.decorators - package org.mbari.vcr4j.decorators
- org.mbari.vcr4j.time - package org.mbari.vcr4j.time
- org.mbari.vcr4j.util - package org.mbari.vcr4j.util
P
- Pair<A,
B> - Class in org.mbari.vcr4j.util - Pair(A, B) - Constructor for class org.mbari.vcr4j.util.Pair
- PAUSE - Enum constant in enum class org.mbari.vcr4j.commands.VideoCommands
- play() - Method in class org.mbari.vcr4j.VideoController
- PLAY - Enum constant in enum class org.mbari.vcr4j.commands.VideoCommands
- Preconditions - Class in org.mbari.vcr4j.util
- Preconditions() - Constructor for class org.mbari.vcr4j.util.Preconditions
R
- randomString(int) - Static method in class org.mbari.vcr4j.util.StringUtils
- REQUEST_DEVICE_TYPE - Enum constant in enum class org.mbari.vcr4j.commands.VideoCommands
- REQUEST_ELAPSED_TIME - Enum constant in enum class org.mbari.vcr4j.commands.VideoCommands
- REQUEST_INDEX - Enum constant in enum class org.mbari.vcr4j.commands.VideoCommands
- REQUEST_STATUS - Enum constant in enum class org.mbari.vcr4j.commands.VideoCommands
- REQUEST_TIMECODE - Enum constant in enum class org.mbari.vcr4j.commands.VideoCommands
- REQUEST_TIMESTAMP - Enum constant in enum class org.mbari.vcr4j.commands.VideoCommands
- requestElapsedTime() - Method in class org.mbari.vcr4j.VideoController
- requestIndex() - Method in class org.mbari.vcr4j.VideoController
-
If you're not sure what the video index is you can call this.
- requestStatus() - Method in class org.mbari.vcr4j.VideoController
- requestTimecode() - Method in class org.mbari.vcr4j.VideoController
- requestTimestamp() - Method in class org.mbari.vcr4j.VideoController
- rewind() - Method in class org.mbari.vcr4j.VideoController
- REWIND - Enum constant in enum class org.mbari.vcr4j.commands.VideoCommands
S
- SchedulerVideoIO<S extends VideoState,
E extends VideoError> - Class in org.mbari.vcr4j.decorators -
Decorator that moves the IO off of the currently executing thread.
- SchedulerVideoIO(VideoIO<S, E>, Scheduler) - Constructor for class org.mbari.vcr4j.decorators.SchedulerVideoIO
- SchedulerVideoIO(VideoIO<S, E>, Executor) - Constructor for class org.mbari.vcr4j.decorators.SchedulerVideoIO
- seek(Duration) - Method in class org.mbari.vcr4j.VideoController
- seek(Instant) - Method in class org.mbari.vcr4j.VideoController
- seek(Timecode) - Method in class org.mbari.vcr4j.VideoController
- SeekElapsedTimeCmd - Class in org.mbari.vcr4j.commands
- SeekElapsedTimeCmd(Duration) - Constructor for class org.mbari.vcr4j.commands.SeekElapsedTimeCmd
- SeekTimecodeCmd - Class in org.mbari.vcr4j.commands
- SeekTimecodeCmd(Timecode) - Constructor for class org.mbari.vcr4j.commands.SeekTimecodeCmd
- SeekTimestampCmd - Class in org.mbari.vcr4j.commands
- SeekTimestampCmd(Instant) - Constructor for class org.mbari.vcr4j.commands.SeekTimestampCmd
- send(A) - Method in class org.mbari.vcr4j.SimpleVideoIO
- send(A) - Method in class org.mbari.vcr4j.VideoController
- send(A) - Method in interface org.mbari.vcr4j.VideoIO
-
Send a command to the video player
- send(VideoCommand) - Method in class org.mbari.vcr4j.decorators.SchedulerVideoIO
- setA(A) - Method in class org.mbari.vcr4j.util.Pair
- setB(B) - Method in class org.mbari.vcr4j.util.Pair
- shuttle(double) - Method in class org.mbari.vcr4j.VideoController
- ShuttleCmd - Class in org.mbari.vcr4j.commands
-
A command to tell the video to shuttle forward (+ values) or backwards (- values).
- ShuttleCmd(double) - Constructor for class org.mbari.vcr4j.commands.ShuttleCmd
- SimpleVideoCommand<A> - Class in org.mbari.vcr4j.commands
- SimpleVideoCommand(String, A) - Constructor for class org.mbari.vcr4j.commands.SimpleVideoCommand
- SimpleVideoError - Class in org.mbari.vcr4j
- SimpleVideoError(boolean) - Constructor for class org.mbari.vcr4j.SimpleVideoError
- SimpleVideoError(boolean, VideoCommand<?>) - Constructor for class org.mbari.vcr4j.SimpleVideoError
- SimpleVideoIO<S extends VideoState,
E extends VideoError> - Class in org.mbari.vcr4j -
Sometimes you need a VideoIO object that is an amalgam of observables from different sources.
- SimpleVideoIO(String, Subject<VideoCommand<?>>, Observable<S>, Observable<E>, Observable<VideoIndex>) - Constructor for class org.mbari.vcr4j.SimpleVideoIO
- size() - Method in class org.mbari.vcr4j.util.Pair
- size() - Method in interface org.mbari.vcr4j.util.Tuple
- stateSubscriber - Variable in class org.mbari.vcr4j.decorators.LoggingDecorator
- StatusDecorator<S extends VideoState,
E extends VideoError> - Class in org.mbari.vcr4j.decorators -
The VideoIO simply executes the commands send.
- StatusDecorator(VideoIO<S, E>) - Constructor for class org.mbari.vcr4j.decorators.StatusDecorator
- stop() - Method in class org.mbari.vcr4j.VideoController
- STOP - Enum constant in enum class org.mbari.vcr4j.commands.VideoCommands
- StringUtils - Class in org.mbari.vcr4j.util
T
- Timecode - Class in org.mbari.vcr4j.time
-
A container for a timecode string in the format of HH:MM:SS:FF (hour:minute:second:frame) If a frameRate is provided the string will be decomposed into frames and framerate
- Timecode(double, double) - Constructor for class org.mbari.vcr4j.time.Timecode
- Timecode(String) - Constructor for class org.mbari.vcr4j.time.Timecode
- Timecode(String, double) - Constructor for class org.mbari.vcr4j.time.Timecode
- toMediaTime(Timecode) - Static method in class org.mbari.vcr4j.time.Converters
- toString() - Method in class org.mbari.vcr4j.decorators.VideoCommandAsString
- toString() - Method in class org.mbari.vcr4j.decorators.VideoErrorAsString
- toString() - Method in class org.mbari.vcr4j.decorators.VideoIndexAsString
- toString() - Method in class org.mbari.vcr4j.decorators.VideoStateAsString
- toString() - Method in class org.mbari.vcr4j.time.HMSF
- toString() - Method in class org.mbari.vcr4j.time.MediaTime
- toString() - Method in class org.mbari.vcr4j.time.Timecode
-
The string represented.
- toString() - Method in class org.mbari.vcr4j.util.Pair
- toString() - Method in class org.mbari.vcr4j.VideoIndex
- toTimecode(HMSF) - Static method in class org.mbari.vcr4j.time.Converters
-
Convert an HMSF to a timecode.
- toTimecode(MediaTime) - Static method in class org.mbari.vcr4j.time.Converters
-
Returns a timecode representation of the mediatime.
- Tuple - Interface in org.mbari.vcr4j.util
U
- unsubscribe() - Method in interface org.mbari.vcr4j.decorators.Decorator
-
Tells the decorator to unsubscribe from all Observables that it is watching.
- unsubscribe() - Method in class org.mbari.vcr4j.decorators.LoggingDecorator
- unsubscribe() - Method in class org.mbari.vcr4j.decorators.SchedulerVideoIO
- unsubscribe() - Method in class org.mbari.vcr4j.decorators.StatusDecorator
- unsubscribe() - Method in class org.mbari.vcr4j.decorators.VCRSyncDecorator
- unsubscribe() - Method in class org.mbari.vcr4j.decorators.VideoSyncDecorator
V
- valueOf(String) - Static method in enum class org.mbari.vcr4j.commands.VideoCommands
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.mbari.vcr4j.commands.VideoCommands
-
Returns an array containing the constants of this enum class, in the order they are declared.
- vcr4j.core - module vcr4j.core
- VCRSyncDecorator<S extends VideoState,
E extends VideoError> - Class in org.mbari.vcr4j.decorators -
This decorator keeps the state, timecodes, and timestamps up to date by scheduling requests frequently.
- VCRSyncDecorator(VideoIO<S, E>) - Constructor for class org.mbari.vcr4j.decorators.VCRSyncDecorator
- VCRSyncDecorator(VideoIO<S, E>, long, long, long) - Constructor for class org.mbari.vcr4j.decorators.VCRSyncDecorator
- VideoCommand<A> - Interface in org.mbari.vcr4j
- VideoCommandAsString - Class in org.mbari.vcr4j.decorators
- VideoCommandAsString(VideoCommand) - Constructor for class org.mbari.vcr4j.decorators.VideoCommandAsString
- VideoCommands - Enum Class in org.mbari.vcr4j.commands
- VideoController<S extends VideoState,
E extends VideoError> - Class in org.mbari.vcr4j - VideoController(VideoIO<S, E>) - Constructor for class org.mbari.vcr4j.VideoController
- VideoError - Interface in org.mbari.vcr4j
- VideoErrorAsString - Class in org.mbari.vcr4j.decorators
- VideoErrorAsString(VideoError) - Constructor for class org.mbari.vcr4j.decorators.VideoErrorAsString
- VideoIndex - Class in org.mbari.vcr4j
-
Represents the index into the video.
- VideoIndex(Duration) - Constructor for class org.mbari.vcr4j.VideoIndex
- VideoIndex(Duration, Instant) - Constructor for class org.mbari.vcr4j.VideoIndex
- VideoIndex(Instant) - Constructor for class org.mbari.vcr4j.VideoIndex
- VideoIndex(Optional<Instant>, Optional<Duration>, Optional<Timecode>) - Constructor for class org.mbari.vcr4j.VideoIndex
- VideoIndex(Timecode) - Constructor for class org.mbari.vcr4j.VideoIndex
- VideoIndexAsString - Class in org.mbari.vcr4j.decorators
- VideoIndexAsString(VideoIndex) - Constructor for class org.mbari.vcr4j.decorators.VideoIndexAsString
- VideoIO<S extends VideoState,
E extends VideoError> - Interface in org.mbari.vcr4j - VideoState - Interface in org.mbari.vcr4j
- VideoStateAsString - Class in org.mbari.vcr4j.decorators
- VideoStateAsString(VideoState) - Constructor for class org.mbari.vcr4j.decorators.VideoStateAsString
- VideoSyncDecorator<S extends VideoState,
E extends VideoError> - Class in org.mbari.vcr4j.decorators -
This decorator schedules requests for status and video index frequently for keepin a UI's state in sync with the video
- VideoSyncDecorator(VideoIO<S, E>) - Constructor for class org.mbari.vcr4j.decorators.VideoSyncDecorator
- VideoSyncDecorator(VideoIO<S, E>, long, long) - Constructor for class org.mbari.vcr4j.decorators.VideoSyncDecorator
Z
- zero() - Static method in class org.mbari.vcr4j.time.HMSF
- zero() - Static method in class org.mbari.vcr4j.time.Timecode
All Classes and Interfaces|All Packages|Constant Field Values