aws-elixir

View Source AWS.ChimeSDKMediaPipelines (aws-elixir v1.0.4)

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.

Link to this section 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 Amazon Kinesis Video Stream pool for use with media stream pipelines.

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 Amazon 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 Amazon Kinesis Video Stream pool in a media pipeline.

Link to this section Functions

Link to this function

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

View Source

Creates a media pipeline.

Link to this function

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

View Source

Creates a media concatenation pipeline.

Link to this function

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

View Source

Creates a media insights pipeline.

Link to this function

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

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source

Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.

If a meeting uses an opt-in Region as its MediaRegion, the KVS stream must be in that same Region. For example, if a meeting uses the af-south-1 Region, the KVS stream must also be in af-south-1. However, if the meeting uses a Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses ca-central-1, the KVS stream can be in eu-west-2, us-east-1, af-south-1, or any other Region that the Amazon Chime SDK supports.

To learn which AWS Region a meeting uses, call the GetMeeting API and use the MediaRegion parameter from the response.

For more information about opt-in Regions, refer to Available Regions in the Amazon Chime SDK Developer Guide, and Specify which AWS Regions your account can use, in the AWS Account Management Reference Guide.

Link to this function

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

View Source

Creates a streaming media pipeline.

Link to this function

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

View Source

Deletes the media pipeline.

Link to this function

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

View Source

Deletes the specified configuration settings.

Link to this function

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

View Source

Deletes the media pipeline.

Link to this function

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

View Source

Deletes an Amazon Kinesis Video Stream pool.

Link to this function

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

View Source

Gets an existing media pipeline.

Link to this function

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

View Source

Gets the configuration settings for a media insights pipeline.

Link to this function

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

View Source

Gets an existing media pipeline.

Link to this function

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

View Source

Gets an Kinesis video stream pool.

Link to this function

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

View Source

Retrieves the details of the specified speaker search task.

Link to this function

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

View Source

Retrieves the details of a voice tone analysis task.

Link to this function

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

View Source

Returns a list of media pipelines.

Link to this function

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

View Source

Lists the available media insights pipeline configurations.

Link to this function

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

View Source

Lists the video stream pools in the media pipeline.

Link to this function

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

View Source

Returns a list of media pipelines.

Link to this function

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

View Source

Lists the tags available for a media pipeline.

Link to this function

metadata()

View Source
Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Stops a speaker search task.

Link to this function

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

View Source

Stops a voice tone analysis task.

Link to this function

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

View Source

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

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

Link to this function

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

View Source

Removes any tags from a media pipeline.

Link to this function

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

View Source

Updates the media insights pipeline's configuration settings.

Link to this function

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

View Source

Updates the status of a media insights pipeline.

Link to this function

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

View Source

Updates an Amazon Kinesis Video Stream pool in a media pipeline.