Package com.amazonaws.kinesisvideo.internal.producer

Interface ServiceCallbacks

All Known Implementing Classes:

CachedInfoMultiAuthServiceCallbacksImpl, DefaultServiceCallbacksImpl, MultiAuthServiceCallbacksImpl

public interface ServiceCallbacks

Interface to the KinesisVideo Producer Stream Service Callbacks functionality. These will be used for scheduling and managing the service calls.

Method Summary

Modifier and Type	Method	Description
void	addStream(KinesisVideoProducerStream kinesisVideoProducerStream)	Add a producer stream to ongoing stream list
void	createDevice(String deviceName, long callAfter, long timeout, byte[] authData, int authType, long customData)	Asynchronous call to create device
void	createStream(String deviceName, String streamName, String contentType, String kmsKeyId, long retentionPeriod, long callAfter, long timeout, byte[] authData, int authType, KinesisVideoProducerStream stream)	Asynchronous call to create stream with the specified parameters.
void	describeStream(String streamName, long callAfter, long timeout, byte[] authData, int authType, long streamHandle, KinesisVideoProducerStream stream)	Asynchronous call to describe stream with the specified parameters.
void	deviceCertToToken(String deviceName, long callAfter, long timeout, byte[] authData, int authType, long customData)	Asynchronous call to device certificate to token API.
void	free()	Frees the callbacks object.
void	getStreamingEndpoint(String streamName, String apiName, long callAfter, long timeout, byte[] authData, int authType, long streamHandle, KinesisVideoProducerStream stream)	Asynchronous call to get streaming endpoint with the specified parameters.
void	getStreamingToken(String streamName, long callAfter, long timeout, byte[] authData, int authType, long streamHandle, KinesisVideoProducerStream stream)	Asynchronous call to get streaming token
void	initialize(KinesisVideoProducer kinesisVideoProducer)	Initializes the callbacks object
boolean	isInitialized()	Returns whether the object is initialized
void	putStream(String streamName, String containerType, long streamStartTime, boolean absoluteFragmentTimes, boolean ackRequired, String streamingEndpoint, long callAfter, long timeout, byte[] authData, int authType, KinesisVideoProducerStream stream)	Asynchronous call to put stream API
void	removeStream(KinesisVideoProducerStream kinesisVideoProducerStream)	Removes a producer stream to ongoing stream list
void	tagResource(String resourceArn, Tag[] tags, long callAfter, long timeout, byte[] authData, int authType, long streamHandle, KinesisVideoProducerStream stream)	Asynchronous call to tag resource API

Method Detail

initialize

void initialize(@Nonnull
                KinesisVideoProducer kinesisVideoProducer)
         throws ProducerException

Initializes the callbacks object

Parameters:

kinesisVideoProducer - Reference to KinesisVideoProducer for the eventing.

Throws:

ProducerException

free

void free()

Frees the callbacks object.

isInitialized

boolean isInitialized()

Returns whether the object is initialized

Returns:

whether the object is initialized

createStream

void createStream(@Nonnull
                  String deviceName,
                  @Nonnull
                  String streamName,
                  @Nonnull
                  String contentType,
                  @Nullable
                  String kmsKeyId,
                  long retentionPeriod,
                  long callAfter,
                  long timeout,
                  @Nullable
                  byte[] authData,
                  int authType,
                  @Nonnull
                  KinesisVideoProducerStream stream)
           throws ProducerException

Asynchronous call to create stream with the specified parameters. PIC will attempt to schedule stream creation if the describeStream(String, long, long, byte[], int, long, KinesisVideoProducerStream) posts a KinesisVideoProducer.describeStreamResult(KinesisVideoProducerStream, long, StreamDescription, int) of 404 (Resource Not Found). This call will be skipped if StreamInfo.isAllowStreamCreation() is not allowed.

This method will notify PIC the success or failure of the operation via KinesisVideoProducer.createStreamResult(KinesisVideoProducerStream, String, int).

Parameters:

deviceName - - Device name

streamName - - Stream name

contentType - - Stream content type

kmsKeyId - - KMS Key Id

retentionPeriod - - Stream retention period - 100ns

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

stream - - stream object for the result event callback

Throws:

ProducerException

See Also:

CreateStream API

describeStream

void describeStream(@Nonnull
                    String streamName,
                    long callAfter,
                    long timeout,
                    @Nullable
                    byte[] authData,
                    int authType,
                    long streamHandle,
                    KinesisVideoProducerStream stream)
             throws ProducerException

Asynchronous call to describe stream with the specified parameters.

This method will notify PIC the success or failure of the operation via KinesisVideoProducer.describeStreamResult(KinesisVideoProducerStream, long, StreamDescription, int)

Parameters:

streamName - - Stream name

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

streamHandle - - stream handle returned by PIC

stream - - stream object for the result event callback

Throws:

ProducerException

See Also:

DescribeStream API

getStreamingEndpoint

void getStreamingEndpoint(@Nonnull
                          String streamName,
                          @Nonnull
                          String apiName,
                          long callAfter,
                          long timeout,
                          @Nullable
                          byte[] authData,
                          int authType,
                          long streamHandle,
                          KinesisVideoProducerStream stream)
                   throws ProducerException

Asynchronous call to get streaming endpoint with the specified parameters.

This method will notify PIC the success or failure of the operation via KinesisVideoProducer.getStreamingEndpointResult(KinesisVideoProducerStream, long, String, int).

Parameters:

streamName - - Stream name

apiName - - API name to call

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

streamHandle - - stream handle returned by PIC

stream - - stream object for the result event callback

Throws:

ProducerException

See Also:

GetDataEndpoint API

getStreamingToken

void getStreamingToken(@Nonnull
                       String streamName,
                       long callAfter,
                       long timeout,
                       @Nullable
                       byte[] authData,
                       int authType,
                       long streamHandle,
                       KinesisVideoProducerStream stream)
                throws ProducerException

Asynchronous call to get streaming token

Parameters:

streamName - - Stream name

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

streamHandle - - stream handle returned by PIC

stream - - stream object for the result event callback

Throws:

ProducerException

putStream

void putStream(@Nonnull
               String streamName,
               @Nonnull
               String containerType,
               long streamStartTime,
               boolean absoluteFragmentTimes,
               boolean ackRequired,
               @Nonnull
               String streamingEndpoint,
               long callAfter,
               long timeout,
               @Nullable
               byte[] authData,
               int authType,
               KinesisVideoProducerStream stream)
        throws ProducerException

Asynchronous call to put stream API

Parameters:

streamName - - Stream name

containerType - - Container type

streamStartTime - - Stream start timestamp

absoluteFragmentTimes - - Whether to use absolute fragment times

ackRequired - - Whether an application level ACK is required

streamingEndpoint - - The streaming endpoint to use

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

stream - - stream object for the result event callback

Throws:

ProducerException

tagResource

void tagResource(@Nonnull
                 String resourceArn,
                 @Nullable
                 Tag[] tags,
                 long callAfter,
                 long timeout,
                 @Nullable
                 byte[] authData,
                 int authType,
                 long streamHandle,
                 KinesisVideoProducerStream stream)
          throws ProducerException

Asynchronous call to tag resource API

Parameters:

resourceArn - - Resource ARN

tags - - Tags to apply

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

streamHandle - - stream handle returned by PIC

stream - - stream object for the result event callback

Throws:

ProducerException

createDevice

void createDevice(@Nonnull
                  String deviceName,
                  long callAfter,
                  long timeout,
                  @Nullable
                  byte[] authData,
                  int authType,
                  long customData)
           throws ProducerException

Asynchronous call to create device

Parameters:

deviceName - - Device name

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

customData - - Custom data to use to call the event functions

Throws:

ProducerException

deviceCertToToken

void deviceCertToToken(@Nonnull
                       String deviceName,
                       long callAfter,
                       long timeout,
                       @Nullable
                       byte[] authData,
                       int authType,
                       long customData)
                throws ProducerException

Asynchronous call to device certificate to token API. Called when AuthType is AUTH_INFO_TYPE_CERT.

Parameters:

deviceName - - Device name

callAfter - - Call after this time - 100ns

timeout - - Time out for the call - 100ns

authData - - Authentication bits

authType - - Authentication type - this is the AUTH_INFO_TYPE defined in /src/client/Include.h

customData - - Custom data to use to call the event functions

Throws:

ProducerException

addStream

void addStream(@Nonnull
               KinesisVideoProducerStream kinesisVideoProducerStream)

Add a producer stream to ongoing stream list

Parameters:

kinesisVideoProducerStream - producer stream used by PIC

removeStream

void removeStream(@Nonnull
                  KinesisVideoProducerStream kinesisVideoProducerStream)

Removes a producer stream to ongoing stream list

Parameters:

kinesisVideoProducerStream - producer stream used by PIC