Interface KinesisVideoProducer
-
- All Known Implementing Classes:
NativeKinesisVideoProducerJni
public interface KinesisVideoProducerInterface to the Kinesis Video Producer functionality
-
-
Field Summary
Fields Modifier and Type Field Description static longREADY_TIMEOUT_IN_MILLISECONDSReady timeout value in milliseconds for the sync API
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidcreate(DeviceInfo deviceInfo)Creates the underlying producer client.voidcreateDeviceResult(long customData, String deviceArn, int httpStatusCode)CreateDevice result eventKinesisVideoProducerStreamcreateStream(StreamInfo streamInfo, StreamCallbacks streamCallbacks)Creates Kinesis Video streamvoidcreateStreamResult(KinesisVideoProducerStream stream, String streamArn, int httpStatusCode)CreateStream result eventKinesisVideoProducerStreamcreateStreamSync(StreamInfo streamInfo, StreamCallbacks streamCallbacks)Creates Kinesis Video stream synchronouslyvoidcreateSync(DeviceInfo deviceInfo)Creates the underlying producer client synchronously.voiddescribeStreamResult(KinesisVideoProducerStream stream, long streamHandle, StreamDescription streamDescription, int httpStatusCode)DescribeStream result eventvoiddeviceCertToTokenResult(long customData, byte[] token, long expiration, int httpStatusCode)DeviceCertToToken result eventvoidfree()Stops the streams and frees/releases the underlying objectvoidfreeStream(KinesisVideoProducerStream stream)Frees the specified streamvoidfreeStreams()Frees all of the underlying streamsKinesisVideoMetricsgetMetrics()voidgetStreamingEndpointResult(KinesisVideoProducerStream stream, long streamHandle, String endpoint, int httpStatusCode)GetStreamingEndpoint result eventvoidgetStreamingTokenResult(KinesisVideoProducerStream stream, long streamHandle, byte[] token, long expiration, int httpStatusCode)GetStreamingToken result eventbooleanisInitialized()Returns whether the client has been initializedbooleanisReady()Returns whether the client has been initialized and ready for the stream to be created.voidputStreamResult(KinesisVideoProducerStream stream, long uploadHandle, int httpStatusCode)PutStream result eventvoidstopStreams()Stops all the streamsvoidtagResourceResult(KinesisVideoProducerStream stream, long streamHandle, int httpStatusCode)TagResource result event
-
-
-
Field Detail
-
READY_TIMEOUT_IN_MILLISECONDS
static final long READY_TIMEOUT_IN_MILLISECONDS
Ready timeout value in milliseconds for the sync API- See Also:
- Constant Field Values
-
-
Method Detail
-
isInitialized
boolean isInitialized()
Returns whether the client has been initialized
-
isReady
boolean isReady()
Returns whether the client has been initialized and ready for the stream to be created.
-
create
void create(@Nonnull DeviceInfo deviceInfo) throws ProducerException
Creates the underlying producer client.- Parameters:
deviceInfo-DeviceInfoobject- Throws:
ProducerException
-
createSync
void createSync(@Nonnull DeviceInfo deviceInfo) throws ProducerException
Creates the underlying producer client synchronously.- Parameters:
deviceInfo-DeviceInfoobject- Throws:
ProducerException
-
free
void free() throws ProducerException
Stops the streams and frees/releases the underlying object- Throws:
ProducerException
-
freeStreams
void freeStreams() throws ProducerExceptionFrees all of the underlying streams- Throws:
ProducerException
-
stopStreams
void stopStreams() throws ProducerExceptionStops all the streams- Throws:
ProducerException
-
createStream
@Nonnull KinesisVideoProducerStream createStream(@Nonnull StreamInfo streamInfo, @Nullable StreamCallbacks streamCallbacks) throws ProducerException
Creates Kinesis Video stream- Parameters:
streamInfo- Stream informationStreamInfoobjectstreamCallbacks- Optional stream callnbacksStreamCallbacks- Returns:
- The newly created stream
- Throws:
ProducerException
-
createStreamSync
@Nonnull KinesisVideoProducerStream createStreamSync(@Nonnull StreamInfo streamInfo, @Nullable StreamCallbacks streamCallbacks) throws ProducerException
Creates Kinesis Video stream synchronously- Parameters:
streamInfo- Stream informationStreamInfoobjectstreamCallbacks- Optional stream callnbacksStreamCallbacks- Returns:
- The newly created stream
- Throws:
ProducerException
-
freeStream
void freeStream(@Nonnull KinesisVideoProducerStream stream) throws ProducerException
Frees the specified stream- Parameters:
stream- Stream to free- Throws:
ProducerException
-
createStreamResult
void createStreamResult(@Nonnull KinesisVideoProducerStream stream, @Nullable String streamArn, int httpStatusCode) throws ProducerException
CreateStream result event- Parameters:
stream- Stream object for the result event callbackstreamArn- Newly create stream ARN on successhttpStatusCode- HTTP status code- Throws:
ProducerException
-
describeStreamResult
void describeStreamResult(@Nonnull KinesisVideoProducerStream stream, long streamHandle, @Nullable StreamDescription streamDescription, int httpStatusCode) throws ProducerException
DescribeStream result event- Parameters:
stream- Stream object for the result event callbackstreamHandle- Stream handle returned by PICstreamDescription- Stream description objecthttpStatusCode- HTTP status code- Throws:
ProducerException
-
getStreamingEndpointResult
void getStreamingEndpointResult(@Nonnull KinesisVideoProducerStream stream, long streamHandle, @Nullable String endpoint, int httpStatusCode) throws ProducerException
GetStreamingEndpoint result event- Parameters:
stream- Stream object for the result event callbackstreamHandle- Stream handle returned by PICendpoint- Streaming endpoint if successfulhttpStatusCode- HTTP status code- Throws:
ProducerException
-
getStreamingTokenResult
void getStreamingTokenResult(@Nonnull KinesisVideoProducerStream stream, long streamHandle, @Nullable byte[] token, long expiration, int httpStatusCode) throws ProducerException
GetStreamingToken result event- Parameters:
stream- Stream object for the result event callbackstreamHandle- Stream handle returned by PICtoken- Streaming token if successfulexpiration- Streaming token expiration in absolute time in 100nshttpStatusCode- HTTP status code- Throws:
ProducerException
-
putStreamResult
void putStreamResult(@Nonnull KinesisVideoProducerStream stream, long uploadHandle, int httpStatusCode) throws ProducerException
PutStream result event- Parameters:
stream- Stream object for the result event callbackuploadHandle- A stream upload handle identifier from the client sidehttpStatusCode- HTTP status code- Throws:
ProducerException
-
tagResourceResult
void tagResourceResult(@Nonnull KinesisVideoProducerStream stream, long streamHandle, int httpStatusCode) throws ProducerException
TagResource result event- Parameters:
stream- Stream object for the result event callbackstreamHandle- Stream handle returned by PIChttpStatusCode- HTTP status code- Throws:
ProducerException
-
createDeviceResult
void createDeviceResult(long customData, @Nullable String deviceArn, int httpStatusCode) throws ProducerExceptionCreateDevice result event- Parameters:
customData- Used for the result event callbackdeviceArn- Newly create device ARN on successhttpStatusCode- HTTP status code- Throws:
ProducerException
-
deviceCertToTokenResult
void deviceCertToTokenResult(long customData, @Nullable byte[] token, long expiration, int httpStatusCode) throws ProducerExceptionDeviceCertToToken result event- Parameters:
customData- Used for the result event callbacktoken- Security token if successfulexpiration- Streaming token expiration in absolute time in 100nshttpStatusCode- HTTP status code- Throws:
ProducerException
-
getMetrics
@Nonnull KinesisVideoMetrics getMetrics() throws ProducerException
- Throws:
ProducerException
-
-