Package com.amazonaws.kinesisvideo.internal.client

Class AbstractKinesisVideoClient

java.lang.Object

com.amazonaws.kinesisvideo.internal.client.AbstractKinesisVideoClient

All Implemented Interfaces:

KinesisVideoClient

Direct Known Subclasses:

NativeKinesisVideoClient

@NotThreadSafe
public abstract class AbstractKinesisVideoClient
extends Object
implements KinesisVideoClient

Abstract Kinesis Video Client implementation which handles some of the common pieces and delegates platform specifics to the implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	mIsInitialized	Whether the object has been initialized
protected org.apache.logging.log4j.Logger	mLog	Logging through this object
protected List<MediaSource>	mMediaSources	Stores the list of streams

Constructor Summary

Constructors

Constructor	Description
AbstractKinesisVideoClient(org.apache.logging.log4j.Logger log)

Method Summary

Modifier and Type	Method	Description
void	free()	Stops the streams and frees/releases the underlying object
void	freeMediaSource(MediaSource mediaSource)	Free media source's binding producer stream
void	initialize(DeviceInfo deviceInfo)	Initializes the client object.
boolean	isInitialized()	Returns whether the client has been initialized
void	registerMediaSource(MediaSource mediaSource)	Register a media source.
void	registerMediaSourceAsync(MediaSource mediaSource)	Register a media source ASYNC.
void	startAllMediaSources()	Resumes the processing
void	stopAllMediaSources()	Pauses the processing
void	unregisterMediaSource(MediaSource mediaSource)	Un-Register a media source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.kinesisvideo.client.KinesisVideoClient

createMediaSource, listSupportedConfigurations

Field Detail

mMediaSources

protected final List<MediaSource> mMediaSources

Stores the list of streams

mIsInitialized

protected boolean mIsInitialized

Whether the object has been initialized

mLog

protected final org.apache.logging.log4j.Logger mLog

Logging through this object

Constructor Detail

AbstractKinesisVideoClient

public AbstractKinesisVideoClient(@Nonnull
                                  org.apache.logging.log4j.Logger log)

Method Detail

isInitialized

public boolean isInitialized()

Returns whether the client has been initialized

Specified by:

isInitialized in interface KinesisVideoClient

Returns:

true if initialized. false otherwise.

initialize

public void initialize(@Nonnull
                       DeviceInfo deviceInfo)
                throws KinesisVideoException

Initializes the client object.

Specified by:

initialize in interface KinesisVideoClient

Parameters:

deviceInfo - Device info for which the client needs to be initialized.

Throws:

KinesisVideoException - if unable to initialize KinesisVideoClient.

startAllMediaSources

public void startAllMediaSources()
                          throws KinesisVideoException

Resumes the processing

Specified by:

startAllMediaSources in interface KinesisVideoClient

Throws:

KinesisVideoException - if unable to start all media sources.

freeMediaSource

public void freeMediaSource(@Nonnull
                            MediaSource mediaSource)
                     throws KinesisVideoException

Free media source's binding producer stream

Specified by:

freeMediaSource in interface KinesisVideoClient

Parameters:

mediaSource - media source binding to kinesis video producer stream to be freed

Throws:

KinesisVideoException - if unable to free media source.

stopAllMediaSources

public void stopAllMediaSources()
                         throws KinesisVideoException

Pauses the processing

Specified by:

stopAllMediaSources in interface KinesisVideoClient

Throws:

KinesisVideoException - if unable to stop all media sources.

free

public void free()
          throws KinesisVideoException

Stops the streams and frees/releases the underlying object

Specified by:

free in interface KinesisVideoClient

Throws:

KinesisVideoException - if unable to free resources.

registerMediaSource

public void registerMediaSource(@Nonnull
                                MediaSource mediaSource)
                         throws KinesisVideoException

Register a media source. The media source will be binding to kinesis video producer stream to send out data from media source.

Specified by:

registerMediaSource in interface KinesisVideoClient

Parameters:

mediaSource - media source binding to kinesis video producer stream

Throws:

KinesisVideoException

registerMediaSourceAsync

public void registerMediaSourceAsync(@Nonnull
                                     MediaSource mediaSource)
                              throws KinesisVideoException

Description copied from interface: KinesisVideoClient

Register a media source ASYNC. The media source will be binding to kinesis video producer stream via CreateStream and send out data from media source. Async call to create the stream and bind to media source.

Specified by:

registerMediaSourceAsync in interface KinesisVideoClient

Parameters:

mediaSource - media source binding to kinesis video producer stream

Throws:

KinesisVideoException - if unable to register media source.

unregisterMediaSource

public void unregisterMediaSource(@Nonnull
                                  MediaSource mediaSource)
                           throws KinesisVideoException

Un-Register a media source. The media source will stop binding to kinesis video producer stream and it cannot send data via producer stream afterwards until register again.

Specified by:

unregisterMediaSource in interface KinesisVideoClient

Parameters:

mediaSource - media source to stop binding to kinesis video producer stream

Throws:

KinesisVideoException