- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
ChimeSDKMediaPipelinesClient
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 .
Installation
npm install @aws-sdk/client-chime-sdk-media-pipelinesyarn add @aws-sdk/client-chime-sdk-media-pipelinespnpm add @aws-sdk/client-chime-sdk-media-pipelinesChimeSDKMediaPipelinesClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| CreateMediaCapturePipelineCommand | Creates a media pipeline. |
| CreateMediaConcatenationPipelineCommand | Creates a media concatenation pipeline. |
| CreateMediaInsightsPipelineCommand | Creates a media insights pipeline. |
| CreateMediaInsightsPipelineConfigurationCommand | A structure that contains the static configurations for a media insights pipeline. |
| CreateMediaLiveConnectorPipelineCommand | Creates a media live connector pipeline in an Amazon Chime SDK meeting. |
| CreateMediaPipelineKinesisVideoStreamPoolCommand | 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 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. |
| CreateMediaStreamPipelineCommand | Creates a streaming media pipeline. |
| DeleteMediaCapturePipelineCommand | Deletes the media pipeline. |
| DeleteMediaInsightsPipelineConfigurationCommand | Deletes the specified configuration settings. |
| DeleteMediaPipelineCommand | Deletes the media pipeline. |
| DeleteMediaPipelineKinesisVideoStreamPoolCommand | Deletes an Amazon Kinesis Video Stream pool. |
| GetMediaCapturePipelineCommand | Gets an existing media pipeline. |
| GetMediaInsightsPipelineConfigurationCommand | Gets the configuration settings for a media insights pipeline. |
| GetMediaPipelineCommand | Gets an existing media pipeline. |
| GetMediaPipelineKinesisVideoStreamPoolCommand | Gets an Kinesis video stream pool. |
| GetSpeakerSearchTaskCommand | Retrieves the details of the specified speaker search task. |
| GetVoiceToneAnalysisTaskCommand | Retrieves the details of a voice tone analysis task. |
| ListMediaCapturePipelinesCommand | Returns a list of media pipelines. |
| ListMediaInsightsPipelineConfigurationsCommand | Lists the available media insights pipeline configurations. |
| ListMediaPipelineKinesisVideoStreamPoolsCommand | Lists the video stream pools in the media pipeline. |
| ListMediaPipelinesCommand | Returns a list of media pipelines. |
| ListTagsForResourceCommand | Lists the tags available for a media pipeline. |
| StartSpeakerSearchTaskCommand | 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. |
| StartVoiceToneAnalysisTaskCommand | 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. |
| StopSpeakerSearchTaskCommand | Stops a speaker search task. |
| StopVoiceToneAnalysisTaskCommand | Stops a voice tone analysis task. |
| TagResourceCommand | The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID. |
| UntagResourceCommand | Removes any tags from a media pipeline. |
| UpdateMediaInsightsPipelineConfigurationCommand | Updates the media insights pipeline's configuration settings. |
| UpdateMediaInsightsPipelineStatusCommand | Updates the status of a media insights pipeline. |
| UpdateMediaPipelineKinesisVideoStreamPoolCommand | Updates an Amazon Kinesis Video Stream pool in a media pipeline. |
ChimeSDKMediaPipelinesClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: ChimeSDKMediaPipelinesClientConfig