Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

ChimeSDKMediaPipelines

import { ChimeSDKMediaPipelines } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/chimesdkmediapipelines.ts?docs=full";
class ChimeSDKMediaPipelines {
constructor(apiFactory: client.ApiFactory);
async createMediaCapturePipeline(params: CreateMediaCapturePipelineRequest, opts?: client.RequestOptions): Promise<CreateMediaCapturePipelineResponse>;
async createMediaConcatenationPipeline(params: CreateMediaConcatenationPipelineRequest, opts?: client.RequestOptions): Promise<CreateMediaConcatenationPipelineResponse>;
async createMediaInsightsPipeline(params: CreateMediaInsightsPipelineRequest, opts?: client.RequestOptions): Promise<CreateMediaInsightsPipelineResponse>;
async createMediaLiveConnectorPipeline(params: CreateMediaLiveConnectorPipelineRequest, opts?: client.RequestOptions): Promise<CreateMediaLiveConnectorPipelineResponse>;
async createMediaStreamPipeline(params: CreateMediaStreamPipelineRequest, opts?: client.RequestOptions): Promise<CreateMediaStreamPipelineResponse>;
async deleteMediaCapturePipeline(params: DeleteMediaCapturePipelineRequest, opts?: client.RequestOptions): Promise<void>;
async deleteMediaInsightsPipelineConfiguration(params: DeleteMediaInsightsPipelineConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
async deleteMediaPipeline(params: DeleteMediaPipelineRequest, opts?: client.RequestOptions): Promise<void>;
async deleteMediaPipelineKinesisVideoStreamPool(params: DeleteMediaPipelineKinesisVideoStreamPoolRequest, opts?: client.RequestOptions): Promise<void>;
async getMediaCapturePipeline(params: GetMediaCapturePipelineRequest, opts?: client.RequestOptions): Promise<GetMediaCapturePipelineResponse>;
async getMediaInsightsPipelineConfiguration(params: GetMediaInsightsPipelineConfigurationRequest, opts?: client.RequestOptions): Promise<GetMediaInsightsPipelineConfigurationResponse>;
async getMediaPipeline(params: GetMediaPipelineRequest, opts?: client.RequestOptions): Promise<GetMediaPipelineResponse>;
async getMediaPipelineKinesisVideoStreamPool(params: GetMediaPipelineKinesisVideoStreamPoolRequest, opts?: client.RequestOptions): Promise<GetMediaPipelineKinesisVideoStreamPoolResponse>;
async getSpeakerSearchTask(params: GetSpeakerSearchTaskRequest, opts?: client.RequestOptions): Promise<GetSpeakerSearchTaskResponse>;
async getVoiceToneAnalysisTask(params: GetVoiceToneAnalysisTaskRequest, opts?: client.RequestOptions): Promise<GetVoiceToneAnalysisTaskResponse>;
async listMediaCapturePipelines(params?: ListMediaCapturePipelinesRequest, opts?: client.RequestOptions): Promise<ListMediaCapturePipelinesResponse>;
async listMediaInsightsPipelineConfigurations(params?: ListMediaInsightsPipelineConfigurationsRequest, opts?: client.RequestOptions): Promise<ListMediaInsightsPipelineConfigurationsResponse>;
async listMediaPipelineKinesisVideoStreamPools(params?: ListMediaPipelineKinesisVideoStreamPoolsRequest, opts?: client.RequestOptions): Promise<ListMediaPipelineKinesisVideoStreamPoolsResponse>;
async listMediaPipelines(params?: ListMediaPipelinesRequest, opts?: client.RequestOptions): Promise<ListMediaPipelinesResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async startSpeakerSearchTask(params: StartSpeakerSearchTaskRequest, opts?: client.RequestOptions): Promise<StartSpeakerSearchTaskResponse>;
async startVoiceToneAnalysisTask(params: StartVoiceToneAnalysisTaskRequest, opts?: client.RequestOptions): Promise<StartVoiceToneAnalysisTaskResponse>;
async stopSpeakerSearchTask(params: StopSpeakerSearchTaskRequest, opts?: client.RequestOptions): Promise<void>;
async stopVoiceToneAnalysisTask(params: StopVoiceToneAnalysisTaskRequest, opts?: client.RequestOptions): Promise<void>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateMediaInsightsPipelineStatus(params: UpdateMediaInsightsPipelineStatusRequest, opts?: client.RequestOptions): Promise<void>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new ChimeSDKMediaPipelines(apiFactory: client.ApiFactory)
[src]

§Methods

§
createMediaCapturePipeline(params: CreateMediaCapturePipelineRequest, opts?: client.RequestOptions): Promise<CreateMediaCapturePipelineResponse>
[src]

Creates a media pipeline.

§
createMediaConcatenationPipeline(params: CreateMediaConcatenationPipelineRequest, opts?: client.RequestOptions): Promise<CreateMediaConcatenationPipelineResponse>
[src]

Creates a media concatenation pipeline.

§
createMediaInsightsPipeline(params: CreateMediaInsightsPipelineRequest, opts?: client.RequestOptions): Promise<CreateMediaInsightsPipelineResponse>
[src]

Creates a media insights pipeline.

§
createMediaInsightsPipelineConfiguration(params: CreateMediaInsightsPipelineConfigurationRequest, opts?: client.RequestOptions): Promise<CreateMediaInsightsPipelineConfigurationResponse>
[src]

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

§
createMediaLiveConnectorPipeline(params: CreateMediaLiveConnectorPipelineRequest, opts?: client.RequestOptions): Promise<CreateMediaLiveConnectorPipelineResponse>
[src]

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

§
createMediaPipelineKinesisVideoStreamPool(params: CreateMediaPipelineKinesisVideoStreamPoolRequest, opts?: client.RequestOptions): Promise<CreateMediaPipelineKinesisVideoStreamPoolResponse>
[src]

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

Note: 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.

§
createMediaStreamPipeline(params: CreateMediaStreamPipelineRequest, opts?: client.RequestOptions): Promise<CreateMediaStreamPipelineResponse>
[src]

Creates a streaming media pipeline.

§
deleteMediaCapturePipeline(params: DeleteMediaCapturePipelineRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the media pipeline.

§
deleteMediaInsightsPipelineConfiguration(params: DeleteMediaInsightsPipelineConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the specified configuration settings.

§
deleteMediaPipeline(params: DeleteMediaPipelineRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes the media pipeline.

§
deleteMediaPipelineKinesisVideoStreamPool(params: DeleteMediaPipelineKinesisVideoStreamPoolRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an Amazon Kinesis Video Stream pool.

§
getMediaCapturePipeline(params: GetMediaCapturePipelineRequest, opts?: client.RequestOptions): Promise<GetMediaCapturePipelineResponse>
[src]

Gets an existing media pipeline.

§
getMediaInsightsPipelineConfiguration(params: GetMediaInsightsPipelineConfigurationRequest, opts?: client.RequestOptions): Promise<GetMediaInsightsPipelineConfigurationResponse>
[src]

Gets the configuration settings for a media insights pipeline.

§
getMediaPipeline(params: GetMediaPipelineRequest, opts?: client.RequestOptions): Promise<GetMediaPipelineResponse>
[src]

Gets an existing media pipeline.

§
getMediaPipelineKinesisVideoStreamPool(params: GetMediaPipelineKinesisVideoStreamPoolRequest, opts?: client.RequestOptions): Promise<GetMediaPipelineKinesisVideoStreamPoolResponse>
[src]

Gets an Kinesis video stream pool.

§
getSpeakerSearchTask(params: GetSpeakerSearchTaskRequest, opts?: client.RequestOptions): Promise<GetSpeakerSearchTaskResponse>
[src]

Retrieves the details of the specified speaker search task.

§
getVoiceToneAnalysisTask(params: GetVoiceToneAnalysisTaskRequest, opts?: client.RequestOptions): Promise<GetVoiceToneAnalysisTaskResponse>
[src]

Retrieves the details of a voice tone analysis task.

§
listMediaCapturePipelines(params?: ListMediaCapturePipelinesRequest, opts?: client.RequestOptions): Promise<ListMediaCapturePipelinesResponse>
[src]

Returns a list of media pipelines.

§
listMediaInsightsPipelineConfigurations(params?: ListMediaInsightsPipelineConfigurationsRequest, opts?: client.RequestOptions): Promise<ListMediaInsightsPipelineConfigurationsResponse>
[src]

Lists the available media insights pipeline configurations.

§
listMediaPipelineKinesisVideoStreamPools(params?: ListMediaPipelineKinesisVideoStreamPoolsRequest, opts?: client.RequestOptions): Promise<ListMediaPipelineKinesisVideoStreamPoolsResponse>
[src]

Lists the video stream pools in the media pipeline.

§
listMediaPipelines(params?: ListMediaPipelinesRequest, opts?: client.RequestOptions): Promise<ListMediaPipelinesResponse>
[src]

Returns a list of media pipelines.

§
listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>
[src]

Lists the tags available for a media pipeline.

§
startSpeakerSearchTask(params: StartSpeakerSearchTaskRequest, opts?: client.RequestOptions): Promise<StartSpeakerSearchTaskResponse>
[src]

Starts a speaker search task.

! IMPORTANT: ! 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.

§
startVoiceToneAnalysisTask(params: StartVoiceToneAnalysisTaskRequest, opts?: client.RequestOptions): Promise<StartVoiceToneAnalysisTaskResponse>
[src]

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.

! IMPORTANT: ! 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.

§
stopSpeakerSearchTask(params: StopSpeakerSearchTaskRequest, opts?: client.RequestOptions): Promise<void>
[src]

Stops a speaker search task.

§
stopVoiceToneAnalysisTask(params: StopVoiceToneAnalysisTaskRequest, opts?: client.RequestOptions): Promise<void>
[src]

Stops a voice tone analysis task.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes any tags from a media pipeline.

§
updateMediaInsightsPipelineConfiguration(params: UpdateMediaInsightsPipelineConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateMediaInsightsPipelineConfigurationResponse>
[src]

Updates the media insights pipeline's configuration settings.

§
updateMediaInsightsPipelineStatus(params: UpdateMediaInsightsPipelineStatusRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates the status of a media insights pipeline.

§
updateMediaPipelineKinesisVideoStreamPool(params: UpdateMediaPipelineKinesisVideoStreamPoolRequest, opts?: client.RequestOptions): Promise<UpdateMediaPipelineKinesisVideoStreamPoolResponse>
[src]

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

§Static Properties