KinesisVideo class

Constructors

KinesisVideo({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createSignalingChannel({required String channelName, ChannelType? channelType, SingleMasterConfiguration? singleMasterConfiguration, List<Tag>? tags}) → Future<CreateSignalingChannelOutput>
Creates a signaling channel.
createStream({required String streamName, int? dataRetentionInHours, String? deviceName, String? kmsKeyId, String? mediaType, Map<String, String>? tags}) → Future<CreateStreamOutput>
Creates a new Kinesis video stream.
deleteSignalingChannel({required String channelARN, String? currentVersion}) → Future<void>
Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted.
deleteStream({required String streamARN, String? currentVersion}) → Future<void>
Deletes a Kinesis video stream and the data contained in the stream.
describeSignalingChannel({String? channelARN, String? channelName}) → Future<DescribeSignalingChannelOutput>
Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe.
describeStream({String? streamARN, String? streamName}) → Future<DescribeStreamOutput>
Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.
getDataEndpoint({required APIName aPIName, String? streamARN, String? streamName}) → Future<GetDataEndpointOutput>
Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation). In the request, specify the stream either by StreamName or StreamARN.
getSignalingChannelEndpoint({required String channelARN, SingleMasterChannelEndpointConfiguration? singleMasterChannelEndpointConfiguration}) → Future<GetSignalingChannelEndpointOutput>
Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.
listSignalingChannels({ChannelNameCondition? channelNameCondition, int? maxResults, String? nextToken}) → Future<ListSignalingChannelsOutput>
Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a ChannelNameCondition.
listStreams({int? maxResults, String? nextToken, StreamNameCondition? streamNameCondition}) → Future<ListStreamsOutput>
Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.
listTagsForResource({required String resourceARN, String? nextToken}) → Future<ListTagsForResourceOutput>
Returns a list of tags associated with the specified signaling channel.
listTagsForStream({String? nextToken, String? streamARN, String? streamName}) → Future<ListTagsForStreamOutput>
Returns a list of tags associated with the specified stream.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
tagResource({required String resourceARN, required List<Tag> tags}) → Future<void>
Adds one or more tags to a signaling channel. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
tagStream({required Map<String, String> tags, String? streamARN, String? streamName}) → Future<void>
Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceARN, required List<String> tagKeyList}) → Future<void>
Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
untagStream({required List<String> tagKeyList, String? streamARN, String? streamName}) → Future<void>
Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.
updateDataRetention({required String currentVersion, required int dataRetentionChangeInHours, required UpdateDataRetentionOperation operation, String? streamARN, String? streamName}) → Future<void>
Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN. This operation requires permission for the KinesisVideo:UpdateDataRetention action.
updateSignalingChannel({required String channelARN, required String currentVersion, SingleMasterConfiguration? singleMasterConfiguration}) → Future<void>
Updates the existing signaling channel. This is an asynchronous operation and takes time to complete.
updateStream({required String currentVersion, String? deviceName, String? mediaType, String? streamARN, String? streamName}) → Future<void>
Updates stream metadata, such as the device name and media type.

Operators

operator ==(Object other) → bool
The equality operator.
inherited