View Source AWS.ChimeSDKMediaPipelines (aws-elixir v0.14.1)

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.

Summary

Functions

create_media_capture_pipeline(client, input, options \\ [])

Creates a media pipeline.

create_media_concatenation_pipeline(client, input, options \\ [])

Creates a media concatenation pipeline.

create_media_insights_pipeline(client, input, options \\ [])

Creates a media insights pipeline.

create_media_insights_pipeline_configuration(client, input, options \\ [])

A structure that contains the static configurations for a media insights pipeline.

create_media_live_connector_pipeline(client, input, options \\ [])

Creates a media live connector pipeline in an Amazon Chime SDK meeting.

create_media_pipeline_kinesis_video_stream_pool(client, input, options \\ [])

Creates an Kinesis video stream pool for the media pipeline.

create_media_stream_pipeline(client, input, options \\ [])

Creates a streaming media pipeline.

delete_media_capture_pipeline(client, media_pipeline_id, input, options \\ [])

Deletes the media pipeline.

delete_media_insights_pipeline_configuration(client, identifier, input, options \\ [])

Deletes the specified configuration settings.

delete_media_pipeline(client, media_pipeline_id, input, options \\ [])

Deletes the media pipeline.

delete_media_pipeline_kinesis_video_stream_pool(client, identifier, input, options \\ [])

Deletes an Kinesis video stream pool.

get_media_capture_pipeline(client, media_pipeline_id, options \\ [])

Gets an existing media pipeline.

get_media_insights_pipeline_configuration(client, identifier, options \\ [])

Gets the configuration settings for a media insights pipeline.

get_media_pipeline(client, media_pipeline_id, options \\ [])

Gets an existing media pipeline.

get_media_pipeline_kinesis_video_stream_pool(client, identifier, options \\ [])

Gets an Kinesis video stream pool.

get_speaker_search_task(client, identifier, speaker_search_task_id, options \\ [])

Retrieves the details of the specified speaker search task.

get_voice_tone_analysis_task(client, identifier, voice_tone_analysis_task_id, options \\ [])

Retrieves the details of a voice tone analysis task.

list_media_capture_pipelines(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of media pipelines.

list_media_insights_pipeline_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the available media insights pipeline configurations.

list_media_pipeline_kinesis_video_stream_pools(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the video stream pools in the media pipeline.

list_media_pipelines(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of media pipelines.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags available for a media pipeline.

metadata()

start_speaker_search_task(client, identifier, input, options \\ [])

Starts a speaker search task.

start_voice_tone_analysis_task(client, identifier, input, options \\ [])

Starts a voice tone analysis task.

stop_speaker_search_task(client, identifier, speaker_search_task_id, input, options \\ [])

Stops a speaker search task.

stop_voice_tone_analysis_task(client, identifier, voice_tone_analysis_task_id, input, options \\ [])

Stops a voice tone analysis task.

tag_resource(client, input, options \\ [])

The ARN of the media pipeline that you want to tag.

untag_resource(client, input, options \\ [])

Removes any tags from a media pipeline.

update_media_insights_pipeline_configuration(client, identifier, input, options \\ [])

Updates the media insights pipeline's configuration settings.

update_media_insights_pipeline_status(client, identifier, input, options \\ [])

Updates the status of a media insights pipeline.

update_media_pipeline_kinesis_video_stream_pool(client, identifier, input, options \\ [])

Updates an Kinesis video stream pool in a media pipeline.

Functions

create_media_capture_pipeline(client, input, options \\ [])

Creates a media pipeline.

create_media_concatenation_pipeline(client, input, options \\ [])

Creates a media concatenation pipeline.

create_media_insights_pipeline(client, input, options \\ [])

Creates a media insights pipeline.

create_media_insights_pipeline_configuration(client, input, options \\ [])

A structure that contains the static configurations for a media insights pipeline.

create_media_live_connector_pipeline(client, input, options \\ [])

Creates a media live connector pipeline in an Amazon Chime SDK meeting.

create_media_pipeline_kinesis_video_stream_pool(client, input, options \\ [])

Creates an Kinesis video stream pool for the media pipeline.

create_media_stream_pipeline(client, input, options \\ [])

Creates a streaming media pipeline.

delete_media_capture_pipeline(client, media_pipeline_id, input, options \\ [])

Deletes the media pipeline.

delete_media_insights_pipeline_configuration(client, identifier, input, options \\ [])

Deletes the specified configuration settings.

delete_media_pipeline(client, media_pipeline_id, input, options \\ [])

Deletes the media pipeline.

delete_media_pipeline_kinesis_video_stream_pool(client, identifier, input, options \\ [])

Deletes an Kinesis video stream pool.

get_media_capture_pipeline(client, media_pipeline_id, options \\ [])

Gets an existing media pipeline.

get_media_insights_pipeline_configuration(client, identifier, options \\ [])

Gets the configuration settings for a media insights pipeline.

get_media_pipeline(client, media_pipeline_id, options \\ [])

Gets an existing media pipeline.

get_media_pipeline_kinesis_video_stream_pool(client, identifier, options \\ [])

Gets an Kinesis video stream pool.

get_speaker_search_task(client, identifier, speaker_search_task_id, options \\ [])

Retrieves the details of the specified speaker search task.

get_voice_tone_analysis_task(client, identifier, voice_tone_analysis_task_id, options \\ [])

Retrieves the details of a voice tone analysis task.

list_media_capture_pipelines(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of media pipelines.

list_media_insights_pipeline_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the available media insights pipeline configurations.

list_media_pipeline_kinesis_video_stream_pools(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the video stream pools in the media pipeline.

list_media_pipelines(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a list of media pipelines.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags available for a media pipeline.

metadata()

start_speaker_search_task(client, identifier, input, options \\ [])

Starts a speaker search task.

Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

start_voice_tone_analysis_task(client, identifier, input, options \\ [])

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.

Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

stop_speaker_search_task(client, identifier, speaker_search_task_id, input, options \\ [])

Stops a speaker search task.

stop_voice_tone_analysis_task(client, identifier, voice_tone_analysis_task_id, input, options \\ [])

Stops a voice tone analysis task.

tag_resource(client, input, options \\ [])

The ARN of the media pipeline that you want to tag.

Consists of the pipeline's endpoint region, resource ID, and pipeline ID.

untag_resource(client, input, options \\ [])

Removes any tags from a media pipeline.

update_media_insights_pipeline_configuration(client, identifier, input, options \\ [])

Updates the media insights pipeline's configuration settings.

update_media_insights_pipeline_status(client, identifier, input, options \\ [])

Updates the status of a media insights pipeline.

update_media_pipeline_kinesis_video_stream_pool(client, identifier, input, options \\ [])

Updates an Kinesis video stream pool in a media pipeline.