java.lang.Object
- com.amazonaws.kinesisvideo.java.mediasource.file.ImageFileMediaSource

All Implemented Interfaces:

MediaSource
```
public class ImageFileMediaSource
extends Object
implements MediaSource
```
MediaSource based on local image files. Currently, this MediaSource expects a series of H264 frames.

Constructor Summary

Constructors
Constructor Description

ImageFileMediaSource(String streamName)

ImageFileMediaSource(String streamName, CompletableFuture<Boolean> future)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`configure(MediaSourceConfiguration configuration)`	Applies configuration settings to this media source.
`void`	`free()`	Releases all resources held by this media source and performs final cleanup.
`MediaSourceConfiguration`	`getConfiguration()`	Returns the configuration object used to create and configure this media source.
`MediaSourceSink`	`getMediaSourceSink()`	Returns the sink that receives frames from this media source.
`MediaSourceState`	`getMediaSourceState()`	Returns the current state of this media source.
`StreamCallbacks`	`getStreamCallbacks()`	Returns stream-specific callback implementations for handling producer events.
`StreamInfo`	`getStreamInfo()`	Returns stream information describing the Kinesis Video Stream this is producing frames for.
`void`	`initialize(MediaSourceSink mediaSourceSink)`	Initializes the media source with a sink that will receive produced frames.
`boolean`	`isStopped()`	Returns true if the media source has been stopped and is no longer producing frames.
`void`	`start()`	Starts frame production and streaming.
`void`	`stop()`	Stops frame production and streaming synchronously.

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

- Constructor Detail
  - ImageFileMediaSource
```
public ImageFileMediaSource(@Nonnull
                            String streamName)
```
  - ImageFileMediaSource
```
public ImageFileMediaSource(@Nonnull
                            String streamName,
                            CompletableFuture<Boolean> future)
```
- Method Detail
  - getMediaSourceState
```
public MediaSourceState getMediaSourceState()
```
    Description copied from interface: MediaSource
    
    Returns the current state of this media source.
    States include: STARTED, STOPPED, etc.
    
    Use this to check if the media source is ready to start streaming.
    
    Specified by:
    
    getMediaSourceState in interface MediaSource
    
    Returns:
    
    the current MediaSourceState
  - getConfiguration
```
public MediaSourceConfiguration getConfiguration()
```
    Description copied from interface: MediaSource
    Returns the configuration object used to create and configure this media source.
    The configuration contains media source specific settings such as:
    
    Media source description
    
    Source-specific parameters (mime type, camera id, file path, etc.)
    Specified by:
    
    getConfiguration in interface MediaSource
    
    Returns:
    
    the MediaSourceConfiguration for this media source
  - getStreamInfo
```
public StreamInfo getStreamInfo()
                         throws KinesisVideoException
```
    Description copied from interface: MediaSource
    
    Returns stream information describing the Kinesis Video Stream this is producing frames for.
    NativeKinesisVideoClient.registerMediaSource(MediaSource) will MediaSource.initialize(MediaSourceSink) it with an instance of ProducerStreamSink created using the provided StreamInfo returned by this method.
    
    Specified by:
    
    getStreamInfo in interface MediaSource
    
    Returns:
    
    the StreamInfo describing this stream
    
    Throws:
    
    KinesisVideoException - if stream info cannot be determined
  - initialize
```
public void initialize(@Nonnull
                       MediaSourceSink mediaSourceSink)
                throws KinesisVideoException
```
    Description copied from interface: MediaSource
    Initializes the media source with a sink that will receive produced frames. NativeKinesisVideoClient.registerMediaSource(MediaSource) will call this method with an instance of ProducerStreamSink created using the provided StreamInfo via MediaSource.getStreamInfo()
    This method:
    
    Establishes the connection between this MediaSource and the provided sink
    
    Prepares the media source for frame production
    
    Must be called before MediaSource.start()
    
    After initialization, the MediaSource should be ready to start producing frames when MediaSource.start() is called.
    Specified by:
    
    initialize in interface MediaSource
    
    Parameters:
    
    mediaSourceSink - the sink that will receive frames from this media source
    
    Throws:
    
    KinesisVideoException - if initialization fails
  - configure
```
public void configure(MediaSourceConfiguration configuration)
```
    Description copied from interface: MediaSource
    
    Applies configuration settings to this media source.
    This method allows runtime configuration of the media source with source-specific parameters. Should typically be called before MediaSource.initialize(MediaSourceSink).
    
    Specified by:
    
    configure in interface MediaSource
    
    Parameters:
    
    configuration - the configuration to apply to this media source
  - start
```
public void start()
           throws KinesisVideoException
```
    Description copied from interface: MediaSource
    Starts frame production and streaming.
    After calling this method:
    
    MediaSource begins capturing/generating frames
    
    Frames are continuously sent to the MediaSourceSink via MediaSourceSink.onFrame(com.amazonaws.kinesisvideo.producer.KinesisVideoFrame)
    
    Codec private data is sent via MediaSourceSink.onCodecPrivateData(byte[])
    
    Any metadata is sent via MediaSourceSink.onFragmentMetadata(String, String, boolean)
    
    The MediaSource must be initialized before starting.
    Specified by:
    
    start in interface MediaSource
    
    Throws:
    
    KinesisVideoException - if the media source cannot be started or is not properly initialized
  - stop
```
public void stop()
          throws KinesisVideoException
```
    Description copied from interface: MediaSource
    Stops frame production and streaming synchronously. This method should be idempotent.
    After calling this method and it returns:
    
    No more frames will be produced or sent to the sink
    
    Resources may be released, but the MediaSource can potentially be restarted
    
    Use MediaSource.isStopped() to verify the stop operation completed
    
    To completely clean up resources, call MediaSource.free() after stopping.
    Specified by:
    
    stop in interface MediaSource
    
    Throws:
    
    KinesisVideoException - if the media source cannot be stopped cleanly
  - isStopped
```
public boolean isStopped()
```
    Description copied from interface: MediaSource
    Returns true if the media source has been stopped and is no longer producing frames.
    This method can be used to:
    
    Verify that MediaSource.stop() completed successfully
    
    Check if the media source needs to be restarted
    
    Determine if cleanup is needed
    Specified by:
    
    isStopped in interface MediaSource
    
    Returns:
    
    true if the media source is stopped, false if it's still active
  - free
```
public void free()
          throws KinesisVideoException
```
    Description copied from interface: MediaSource
    Releases all resources held by this media source and performs final cleanup.
    NativeKinesisVideoClient will call this when NativeKinesisVideoClient.free() is called with this Media Source still registered. If the Media Source was NativeKinesisVideoClient.unregisterMediaSource(MediaSource), then you will need to call this method yourself.
    MediaSource cannot be used again after freeing.
    
    This method:
    
    Releases native resources (the native Kinesis Video Stream).
    
    Should be called after MediaSource.stop() to ensure clean shutdown
    
    Makes the MediaSource unusable - it cannot be restarted after freeing
    Specified by:
    
    free in interface MediaSource
    
    Throws:
    
    KinesisVideoException - if cleanup fails
  - getMediaSourceSink
```
public MediaSourceSink getMediaSourceSink()
```
    Description copied from interface: MediaSource
    
    Returns the sink that receives frames from this media source.
    This is the same sink that was provided to MediaSource.initialize(MediaSourceSink). Useful for accessing the underlying producer stream or for debugging.
    
    Specified by:
    
    getMediaSourceSink in interface MediaSource
    
    Returns:
    
    the MediaSourceSink receiving frames from this source, or null if not initialized
  - getStreamCallbacks
```
@Nullable
public StreamCallbacks getStreamCallbacks()
```
    Description copied from interface: MediaSource
    Returns stream-specific callback implementations for handling producer events.
    StreamCallbacks allow the MediaSource to:
    
    Receive acknowledgments from Kinesis Video Streams
    
    Handle stream errors and implement custom retry logic
    
    Monitor stream health and performance metrics
    
    Implement custom stream lifecycle management
    
    Return null if no custom callbacks are needed (default behavior will be used).
    Specified by:
    
    getStreamCallbacks in interface MediaSource
    
    Returns:
    
    custom StreamCallbacks implementation, or null for default behavior

Constructor	Description
`ImageFileMediaSource(String streamName)`
`ImageFileMediaSource(String streamName, CompletableFuture<Boolean> future)`

Class ImageFileMediaSource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageFileMediaSource

ImageFileMediaSource

Method Detail

getMediaSourceState

getConfiguration

getStreamInfo

initialize

configure

start

stop

isStopped

free

getMediaSourceSink

getStreamCallbacks