com.amazonaws.kinesisvideo.client

Interface KinesisVideoClient

All Known Implementing Classes:

com.amazonaws.kinesisvideo.internal.client.AbstractKinesisVideoClient, AndroidKinesisVideoClient, com.amazonaws.kinesisvideo.internal.client.NativeKinesisVideoClient

public interface KinesisVideoClient

Top level interface representing an Kinesis Video Streams client

Method Summary

Modifier and Type	Method and Description
com.amazonaws.kinesisvideo.internal.client.mediasource.MediaSource	createMediaSource(String streamName, com.amazonaws.kinesisvideo.internal.client.mediasource.MediaSourceConfiguration mediaSourceConfiguration) Try create a media source.
void	free() Stops the media sources and frees/releases the underlying objects
void	initialize(DeviceInfo deviceInfo) Initializes the client object.
boolean	isInitialized() Returns whether the client has been initialized
List<com.amazonaws.kinesisvideo.internal.client.mediasource.MediaSourceConfiguration.Builder<? extends com.amazonaws.kinesisvideo.internal.client.mediasource.MediaSourceConfiguration>>	listSupportedConfigurations() List few known media sources available to the application.
void	registerMediaSource(com.amazonaws.kinesisvideo.internal.client.mediasource.MediaSource mediaSource) Register a media source.
void	startAllMediaSources() Start all registered media sources
void	stopAllMediaSources() Stop all registered media sources
void	unregisterMediaSource(com.amazonaws.kinesisvideo.internal.client.mediasource.MediaSource mediaSource) Un-Register a media source.

Method Detail

isInitialized

boolean isInitialized()

Returns whether the client has been initialized

initialize

void initialize(@NonNull
                DeviceInfo deviceInfo)
         throws KinesisVideoException

Initializes the client object.

Throws:

KinesisVideoException

listSupportedConfigurations

List<com.amazonaws.kinesisvideo.internal.client.mediasource.MediaSourceConfiguration.Builder<? extends com.amazonaws.kinesisvideo.internal.client.mediasource.MediaSourceConfiguration>> listSupportedConfigurations()

List few known media sources available to the application. The configurations returned are expected to be working as is. The returned list is not exhaustive, some working configurations will likely be missing from the list.

Returns:

list of configuration builders to allow further configuration

registerMediaSource

void registerMediaSource(com.amazonaws.kinesisvideo.internal.client.mediasource.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.

Parameters:

mediaSource - media source binding to kinesis video producer stream

Throws:

KinesisVideoException

unregisterMediaSource

void unregisterMediaSource(com.amazonaws.kinesisvideo.internal.client.mediasource.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.

Parameters:

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

Throws:

KinesisVideoException

startAllMediaSources

void startAllMediaSources()
                   throws KinesisVideoException

Start all registered media sources

Throws:

KinesisVideoException

stopAllMediaSources

void stopAllMediaSources()
                  throws KinesisVideoException

Stop all registered media sources

Throws:

KinesisVideoException

createMediaSource

com.amazonaws.kinesisvideo.internal.client.mediasource.MediaSource createMediaSource(String streamName,
                                                                                     com.amazonaws.kinesisvideo.internal.client.mediasource.MediaSourceConfiguration mediaSourceConfiguration)
                                                                              throws KinesisVideoException

Try create a media source. Use the mediaSourceConfiguration to determine, the media source type, create the instance, and ensure that it is configured with working parameters

Parameters:

mediaSourceConfiguration, - configuration to create specific media source

Returns:

configured and working media source

Throws:

UnsupportedConfigurationException - is thrown when the configuration is not supported, e.g. camera resolution or encoding

UnknownMediaSourceException - is thrown when the media source type is unknown and cannot be created

KinesisVideoException

free

void free()
   throws KinesisVideoException

Stops the media sources and frees/releases the underlying objects

Throws:

KinesisVideoException