ChimeSdkMediaPipelines class

The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines that capture, concatenate, or stream your Amazon Chime SDK meetings. For more information about media pipelines, see Amazon Chime SDK media pipelines.

Constructors

ChimeSdkMediaPipelines({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false})
factory

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.
createMediaCapturePipeline({required String sinkArn, required MediaPipelineSinkType sinkType, required String sourceArn, required MediaPipelineSourceType sourceType, ChimeSdkMeetingConfiguration? chimeSdkMeetingConfiguration, String? clientRequestToken, String? sinkIamRoleArn, SseAwsKeyManagementParams? sseAwsKeyManagementParams, List<Tag>? tags}) → Future<CreateMediaCapturePipelineResponse>
Creates a media pipeline.
createMediaConcatenationPipeline({required List<ConcatenationSink> sinks, required List<ConcatenationSource> sources, String? clientRequestToken, List<Tag>? tags}) → Future<CreateMediaConcatenationPipelineResponse>
Creates a media concatenation pipeline.
createMediaInsightsPipeline({required String mediaInsightsPipelineConfigurationArn, String? clientRequestToken, KinesisVideoStreamRecordingSourceRuntimeConfiguration? kinesisVideoStreamRecordingSourceRuntimeConfiguration, KinesisVideoStreamSourceRuntimeConfiguration? kinesisVideoStreamSourceRuntimeConfiguration, Map<String, String>? mediaInsightsRuntimeMetadata, S3RecordingSinkRuntimeConfiguration? s3RecordingSinkRuntimeConfiguration, List<Tag>? tags}) → Future<CreateMediaInsightsPipelineResponse>
Creates a media insights pipeline.
createMediaInsightsPipelineConfiguration({required List<MediaInsightsPipelineConfigurationElement> elements, required String mediaInsightsPipelineConfigurationName, required String resourceAccessRoleArn, String? clientRequestToken, RealTimeAlertConfiguration? realTimeAlertConfiguration, List<Tag>? tags}) → Future<CreateMediaInsightsPipelineConfigurationResponse>
A structure that contains the static configurations for a media insights pipeline.
createMediaLiveConnectorPipeline({required List<LiveConnectorSinkConfiguration> sinks, required List<LiveConnectorSourceConfiguration> sources, String? clientRequestToken, List<Tag>? tags}) → Future<CreateMediaLiveConnectorPipelineResponse>
Creates a media live connector pipeline in an Amazon Chime SDK meeting.
createMediaPipelineKinesisVideoStreamPool({required String poolName, required KinesisVideoStreamConfiguration streamConfiguration, String? clientRequestToken, List<Tag>? tags}) → Future<CreateMediaPipelineKinesisVideoStreamPoolResponse>
Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.
createMediaStreamPipeline({required List<MediaStreamSink> sinks, required List<MediaStreamSource> sources, String? clientRequestToken, List<Tag>? tags}) → Future<CreateMediaStreamPipelineResponse>
Creates a streaming media pipeline.
deleteMediaCapturePipeline({required String mediaPipelineId}) → Future<void>
Deletes the media pipeline.
deleteMediaInsightsPipelineConfiguration({required String identifier}) → Future<void>
Deletes the specified configuration settings.
deleteMediaPipeline({required String mediaPipelineId}) → Future<void>
Deletes the media pipeline.
deleteMediaPipelineKinesisVideoStreamPool({required String identifier}) → Future<void>
Deletes an Amazon Kinesis Video Stream pool.
getMediaCapturePipeline({required String mediaPipelineId}) → Future<GetMediaCapturePipelineResponse>
Gets an existing media pipeline.
getMediaInsightsPipelineConfiguration({required String identifier}) → Future<GetMediaInsightsPipelineConfigurationResponse>
Gets the configuration settings for a media insights pipeline.
getMediaPipeline({required String mediaPipelineId}) → Future<GetMediaPipelineResponse>
Gets an existing media pipeline.
getMediaPipelineKinesisVideoStreamPool({required String identifier}) → Future<GetMediaPipelineKinesisVideoStreamPoolResponse>
Gets an Kinesis video stream pool.
getSpeakerSearchTask({required String identifier, required String speakerSearchTaskId}) → Future<GetSpeakerSearchTaskResponse>
Retrieves the details of the specified speaker search task.
getVoiceToneAnalysisTask({required String identifier, required String voiceToneAnalysisTaskId}) → Future<GetVoiceToneAnalysisTaskResponse>
Retrieves the details of a voice tone analysis task.
listMediaCapturePipelines({int? maxResults, String? nextToken}) → Future<ListMediaCapturePipelinesResponse>
Returns a list of media pipelines.
listMediaInsightsPipelineConfigurations({int? maxResults, String? nextToken}) → Future<ListMediaInsightsPipelineConfigurationsResponse>
Lists the available media insights pipeline configurations.
listMediaPipelineKinesisVideoStreamPools({int? maxResults, String? nextToken}) → Future<ListMediaPipelineKinesisVideoStreamPoolsResponse>
Lists the video stream pools in the media pipeline.
listMediaPipelines({int? maxResults, String? nextToken}) → Future<ListMediaPipelinesResponse>
Returns a list of media pipelines.
listTagsForResource({required String resourceARN}) → Future<ListTagsForResourceResponse>
Lists the tags available for a media pipeline.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
startSpeakerSearchTask({required String identifier, required String voiceProfileDomainArn, String? clientRequestToken, KinesisVideoStreamSourceTaskConfiguration? kinesisVideoStreamSourceTaskConfiguration}) → Future<StartSpeakerSearchTaskResponse>
Starts a speaker search task.
startVoiceToneAnalysisTask({required String identifier, required VoiceAnalyticsLanguageCode languageCode, String? clientRequestToken, KinesisVideoStreamSourceTaskConfiguration? kinesisVideoStreamSourceTaskConfiguration}) → Future<StartVoiceToneAnalysisTaskResponse>
Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime SDK voice analytics in the Amazon Chime SDK Developer Guide.
stopSpeakerSearchTask({required String identifier, required String speakerSearchTaskId}) → Future<void>
Stops a speaker search task.
stopVoiceToneAnalysisTask({required String identifier, required String voiceToneAnalysisTaskId}) → Future<void>
Stops a voice tone analysis task.
tagResource({required String resourceARN, required List<Tag> tags}) → Future<void>
The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceARN, required List<String> tagKeys}) → Future<void>
Removes any tags from a media pipeline.
updateMediaInsightsPipelineConfiguration({required List<MediaInsightsPipelineConfigurationElement> elements, required String identifier, required String resourceAccessRoleArn, RealTimeAlertConfiguration? realTimeAlertConfiguration}) → Future<UpdateMediaInsightsPipelineConfigurationResponse>
Updates the media insights pipeline's configuration settings.
updateMediaInsightsPipelineStatus({required String identifier, required MediaPipelineStatusUpdate updateStatus}) → Future<void>
Updates the status of a media insights pipeline.
updateMediaPipelineKinesisVideoStreamPool({required String identifier, KinesisVideoStreamConfigurationUpdate? streamConfiguration}) → Future<UpdateMediaPipelineKinesisVideoStreamPoolResponse>
Updates an Amazon Kinesis Video Stream pool in a media pipeline.

Operators

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