VideoStream

java.lang.Object
- agi.foundation.graphics.imaging.Raster
- - agi.foundation.graphics.imaging.RasterStream
  - - agi.foundation.graphics.imaging.VideoStream

All Implemented Interfaces:

IDisposable, AutoCloseable
```
public final class VideoStream
extends RasterStream
implements IDisposable
```
A raster stream that streams from a video. The video can be read from a file, or streamed from an HTTP, RTP, UDP, or TCP source. See the Video Streams topic for a list of supported video formats and Uri usage.

See Also:

RasterStream, Video Streams topic, Video Streams on Models topic, Raster and Projection Streams topic

Constructor Summary

Constructors
Constructor and Description
`VideoStream(String uri)` Initializes the video stream from a Uri, which can be a file, HTTP, RTP, UDP, or TCP source.
`VideoStream(URI uri)` Initializes the video stream from a Uri, which can be a file, HTTP, RTP, UDP, or TCP source.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeStreamAndResources()` Closes the video stream and any associated resources.
`protected void`	`dispose(boolean disposing)`
`protected void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`boolean`	`getAllowFrameDrop()` Gets a value indicating if frames should be dropped if video processing can not keep up with a video stream.
`int`	`getEndFrame()` Gets the end frame of the video.
`double`	`getEndTime()` Gets the end time of the video in seconds.
`double`	`getFrameRate()` Gets the frame rate of the video when the `Playback` property is set to `RealTime`.
`JulianDate`	`getIntervalEndTime()` Gets the `SceneManager` time at which the video will stop playing when the `Playback` property is set to `videoplayback.TimeInterval`.
`JulianDate`	`getIntervalStartTime()` Gets the `SceneManager` time at which the video will begin playing when the `Playback` property is set to `videoplayback.TimeInterval`.
`boolean`	`getIsPlaying()` Gets whether or not the video is playing.
`boolean`	`getLoop()` Gets whether the video will loop when it reaches its last frame when the `Playback` property is set to `RealTime`.
`int`	`getPacketAcquirementYieldTime()` Gets the thread processing yield time for asynchronous streaming of video over common protocols like udp.
`int`	`getPacketBufferLimit()` Gets a value indicating the buffering limit for packets when processing a video stream.
`VideoPlayback`	`getPlayback()` Gets the `VideoPlayback` mode of the video.
`int`	`getStartFrame()` Gets the start frame of the video.
`double`	`getStartTime()` Gets the start time of the video in seconds.
`URI`	`getUri()` Gets the `URI` of the video.
`void`	`pause()` Pauses the video when the `Playback` property is set to `RealTime`.
`void`	`play()` Begins playing the video when the `Playback` property is set to `RealTime`.
`void`	`reinitializeWithStringUri(String uri)` Reinitializes the video stream from a Uri, which can be a file, HTTP, RTP, UDP, or TCP source.
`void`	`reset()` Seeks the video to its first frame and begins playing the video when the `Playback` property is set to `RealTime`.
`void`	`setAllowFrameDrop(boolean allow)` Sets a value indicating if frames should be dropped if video processing can not keep up with a video stream.
`void`	`setEndFrame(int value)` Sets the end frame of the video.
`void`	`setEndTime(double value)` Sets the end time of the video in seconds.
`void`	`setFrameRate(double value)` Sets the frame rate of the video when the `Playback` property is set to `RealTime`.
`void`	`setIntervalEndTime(JulianDate value)` Sets the `SceneManager` time at which the video will stop playing when the `Playback` property is set to `videoplayback.TimeInterval`.
`void`	`setIntervalStartTime(JulianDate value)` Sets the `SceneManager` time at which the video will begin playing when the `Playback` property is set to `videoplayback.TimeInterval`.
`void`	`setLoop(boolean value)` Sets whether the video will loop when it reaches its last frame when the `Playback` property is set to `RealTime`.
`void`	`setPacketAcquirementYieldTime(int newPacketAquirementSleepTime)` Sets the thread processing yield time for asynchronous streaming of video over common protocols like udp.
`void`	`setPacketBufferLimit(int newPacketAquirementSleepTime)` Sets a value indicating the buffering limit for packets when processing a video stream.
`void`	`setPlayback(VideoPlayback value)` Sets the `VideoPlayback` mode of the video.
`void`	`setStartFrame(int value)` Sets the start frame of the video.
`void`	`setStartTime(double value)` Sets the start time of the video in seconds.
`void`	`stop()` Stops the video when the `Playback` property is set to `RealTime`.
`boolean`	`update(JulianDate time, JulianDate nextTime)` When overridden in a derived class, updates the raster data associated with the raster stream at the specified time.

Methods inherited from class agi.foundation.graphics.imaging.RasterStream
getUpdateDelta, setUpdateDelta

Methods inherited from class agi.foundation.graphics.imaging.Raster
apply, applyInPlace, copyFromBitmap, copyFromMemory, copyFromRaster, dispose, extractBand, extractBand, flip, getAttributes, getHeight, getWidth, rotate, setAttributes, toBitmap

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface agi.foundation.compatibility.IDisposable
close, dispose

- Constructor Detail
  - VideoStream
```
public VideoStream(URI uri)
```
    Initializes the video stream from a Uri, which can be a file, HTTP, RTP, UDP, or TCP source. See the Video Streams topic for a list of supported video formats and Uri usage.
    
    Parameters:
    
    uri - The URI of the video.
  - VideoStream
```
public VideoStream(String uri)
```
    Initializes the video stream from a Uri, which can be a file, HTTP, RTP, UDP, or TCP source. See the Video Streams topic for a list of supported video formats and Uri usage.
    
    Parameters:
    
    uri - The Uri of the video.
- Method Detail
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Description copied from class: java.lang.Object
    
    Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.
    The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.
    The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.
    The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.
    After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.
    The finalize method is never invoked more than once by a Java virtual machine for any given object.
    Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.
    
    Overrides:
    
    finalize in class Raster
    
    Throws:
    
    Throwable - the Exception raised by this method
    
    See Also:
    
    WeakReference, PhantomReference
  - dispose
```
protected void dispose(boolean disposing)
```
    Overrides:
    
    dispose in class RasterStream
  - getUri
```
public final URI getUri()
```
    Gets the URI of the video.
  - getPlayback
```
public final VideoPlayback getPlayback()
```
    Gets the VideoPlayback mode of the video.
  - setPlayback
```
public final void setPlayback(VideoPlayback value)
```
    Sets the VideoPlayback mode of the video.
  - getFrameRate
```
public final double getFrameRate()
```
    Gets the frame rate of the video when the Playback property is set to RealTime. If this property is not set, the internal framerate of the video is used.
  - setFrameRate
```
public final void setFrameRate(double value)
```
    Sets the frame rate of the video when the Playback property is set to RealTime. If this property is not set, the internal framerate of the video is used.
  - getIntervalStartTime
```
public final JulianDate getIntervalStartTime()
```
    Gets the SceneManager time at which the video will begin playing when the Playback property is set to videoplayback.TimeInterval.
  - setIntervalStartTime
```
public final void setIntervalStartTime(JulianDate value)
```
    Sets the SceneManager time at which the video will begin playing when the Playback property is set to videoplayback.TimeInterval.
  - getIntervalEndTime
```
public final JulianDate getIntervalEndTime()
```
    Gets the SceneManager time at which the video will stop playing when the Playback property is set to videoplayback.TimeInterval.
  - setIntervalEndTime
```
public final void setIntervalEndTime(JulianDate value)
```
    Sets the SceneManager time at which the video will stop playing when the Playback property is set to videoplayback.TimeInterval.
  - getStartTime
```
public final double getStartTime()
```
    Gets the start time of the video in seconds. Changing the StartTime property also changes the StartFrame property to the frame in the video that corresponds to the specified time.
  - setStartTime
```
public final void setStartTime(double value)
```
    Sets the start time of the video in seconds. Changing the StartTime property also changes the StartFrame property to the frame in the video that corresponds to the specified time.
  - getEndTime
```
public final double getEndTime()
```
    Gets the end time of the video in seconds. Changing the EndTime property also changes the EndFrame property to the frame in the video that corresponds to the specified time.
  - setEndTime
```
public final void setEndTime(double value)
```
    Sets the end time of the video in seconds. Changing the EndTime property also changes the EndFrame property to the frame in the video that corresponds to the specified time.
  - getStartFrame
```
public final int getStartFrame()
```
    Gets the start frame of the video. Changing the StartFrame property also changes the StartTime property to the time in the video that corresponds to the specified frame.
  - setStartFrame
```
public final void setStartFrame(int value)
```
    Sets the start frame of the video. Changing the StartFrame property also changes the StartTime property to the time in the video that corresponds to the specified frame.
  - getEndFrame
```
public final int getEndFrame()
```
    Gets the end frame of the video. Changing the EndFrame property also changes the EndTime property to the time in the video that corresponds to the specified frame.
  - setEndFrame
```
public final void setEndFrame(int value)
```
    Sets the end frame of the video. Changing the EndFrame property also changes the EndTime property to the time in the video that corresponds to the specified frame.
  - getLoop
```
public final boolean getLoop()
```
    Gets whether the video will loop when it reaches its last frame when the Playback property is set to RealTime.
  - setLoop
```
public final void setLoop(boolean value)
```
    Sets whether the video will loop when it reaches its last frame when the Playback property is set to RealTime.
  - getIsPlaying
```
public final boolean getIsPlaying()
```
    Gets whether or not the video is playing. Use the Play, Pause, Stop, and Reset methods to control the playback of the video when the Playback property is set to RealTime.
  - getPacketAcquirementYieldTime
```
public final int getPacketAcquirementYieldTime()
```
    Gets the thread processing yield time for asynchronous streaming of video over common protocols like udp. Setting a high value may increase performance, but may cause frames or packets to drop, effecting visual quality. A lower value will ensure high priority processing of the stream, and thus less visual degradation, but may affect performance.
  - setPacketAcquirementYieldTime
```
public final void setPacketAcquirementYieldTime(int newPacketAquirementSleepTime)
```
    Sets the thread processing yield time for asynchronous streaming of video over common protocols like udp. Setting a high value may increase performance, but may cause frames or packets to drop, effecting visual quality. A lower value will ensure high priority processing of the stream, and thus less visual degradation, but may affect performance.
  - getPacketBufferLimit
```
public final int getPacketBufferLimit()
```
    Gets a value indicating the buffering limit for packets when processing a video stream. Increasing this value will provide more buffering of the video stream when frame processing cannot keep up, but has memory implications and may result in the video falling behind, or eventual visual degradation, if the frame processing load is not lessened.
  - setPacketBufferLimit
```
public final void setPacketBufferLimit(int newPacketAquirementSleepTime)
```
    Sets a value indicating the buffering limit for packets when processing a video stream. Increasing this value will provide more buffering of the video stream when frame processing cannot keep up, but has memory implications and may result in the video falling behind, or eventual visual degradation, if the frame processing load is not lessened.
  - getAllowFrameDrop
```
public final boolean getAllowFrameDrop()
```
    Gets a value indicating if frames should be dropped if video processing can not keep up with a video stream. If this is set to false, the video quality may degrade when the processing load is too high. Alternatively, when set to true, frames will be dropped, but each frame that is processed should have an improved visual quality.
  - setAllowFrameDrop
```
public final void setAllowFrameDrop(boolean allow)
```
    Sets a value indicating if frames should be dropped if video processing can not keep up with a video stream. If this is set to false, the video quality may degrade when the processing load is too high. Alternatively, when set to true, frames will be dropped, but each frame that is processed should have an improved visual quality.
  - reinitializeWithStringUri
```
public final void reinitializeWithStringUri(String uri)
```
    Reinitializes the video stream from a Uri, which can be a file, HTTP, RTP, UDP, or TCP source. See the Video Streams topic for a list of supported video formats and Uri usage.
    
    Parameters:
    
    uri - The Uri of the video.
  - play
```
public final void play()
```
    Begins playing the video when the Playback property is set to RealTime.
  - pause
```
public final void pause()
```
    Pauses the video when the Playback property is set to RealTime.
  - stop
```
public final void stop()
```
    Stops the video when the Playback property is set to RealTime. Stopping the video will seek to the first frame and pause playback. Use the Play method to begin playing the video again.
  - reset
```
public final void reset()
```
    Seeks the video to its first frame and begins playing the video when the Playback property is set to RealTime.
  - closeStreamAndResources
```
public final void closeStreamAndResources()
```
    Closes the video stream and any associated resources.
  - update
```
public boolean update(JulianDate time,
                      JulianDate nextTime)
```
    Description copied from class: RasterStream
    
    When overridden in a derived class, updates the raster data associated with the raster stream at the specified time. When the Update method is called, the raster stream contains a raster data buffer defined by the current Attributes (get) of the stream for updating the raster data. The time parameter provides the current and next SceneManager time. Return true if the raster data was updated, otherwise return false.
    
    Specified by:
    
    update in class RasterStream
    
    Parameters:
    
    time - The current SceneManager time.
    
    nextTime - The next SceneManager time.
    
    Returns:
    
    True if the stream was updated, and false if it was not.

Class VideoStream

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.graphics.imaging.RasterStream

Methods inherited from class agi.foundation.graphics.imaging.Raster

Methods inherited from class java.lang.Object

Methods inherited from interface agi.foundation.compatibility.IDisposable

Constructor Detail

VideoStream

Method Detail

finalize

dispose

getUri

getPlayback

setPlayback

getFrameRate

setFrameRate

getIntervalStartTime

setIntervalStartTime

getIntervalEndTime

setIntervalEndTime

getStartTime

setStartTime

getEndTime

setEndTime

getStartFrame

setStartFrame

getEndFrame

setEndFrame

getLoop

setLoop

getIsPlaying

getPacketAcquirementYieldTime

setPacketAcquirementYieldTime

getPacketBufferLimit

setPacketBufferLimit

getAllowFrameDrop

setAllowFrameDrop

reinitializeWithStringUri

play

pause

stop

reset

closeStreamAndResources

update