ChimeSDKMediaPipelines.Client.create_media_capture_pipeline(**kwargs)¶Creates a media pipeline.
See also: AWS API Documentation
Request Syntax
response = client.create_media_capture_pipeline(
SourceType='ChimeSdkMeeting',
SourceArn='string',
SinkType='S3Bucket',
SinkArn='string',
ClientRequestToken='string',
ChimeSdkMeetingConfiguration={
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
},
'ArtifactsConfiguration': {
'Audio': {
'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'|'AudioWithCompositedVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
},
'CompositedVideo': {
'Layout': 'GridView',
'Resolution': 'HD'|'FHD',
'GridViewConfiguration': {
'ContentShareLayout': 'PresenterOnly'|'Horizontal'|'Vertical',
'PresenterOnlyConfiguration': {
'PresenterPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
}
}
}
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.
[REQUIRED]
ARN of the source from which the media artifacts are captured.
[REQUIRED]
Destination type to which the media artifacts are saved. You must use an S3 bucket.
[REQUIRED]
The ARN of the sink type.
The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.
This field is autopopulated if not provided.
The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting .
The source configuration for a specified media pipline.
The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.
The attendee IDs of the streams selected for a media pipeline.
The external user IDs of the streams selected for a media pipeline.
The configuration for the artifacts in an Amazon Chime SDK meeting.
The configuration for the audio artifacts.
The MUX type of the audio artifact configuration object.
The configuration for the video artifacts.
Indicates whether the video artifact is enabled or disabled.
The MUX type of the video artifact configuration object.
The configuration for the content artifacts.
Indicates whether the content artifact is enabled or disabled.
The MUX type of the artifact configuration.
Enables video compositing.
The layout setting, such as GridView in the configuration object.
The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
The GridView configuration setting.
Defines the layout of the video tiles when content sharing is enabled.
Defines the configuration options for a presenter only video tile.
Defines the position of the presenter video tile. Default: TopRight .
The tag key-value pairs.
A key/value pair that grants users access to meeting resources.
The key half of a tag.
The value half of a tag.
dict
Response Syntax
{
'MediaCapturePipeline': {
'MediaPipelineId': 'string',
'MediaPipelineArn': 'string',
'SourceType': 'ChimeSdkMeeting',
'SourceArn': 'string',
'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
'SinkType': 'S3Bucket',
'SinkArn': 'string',
'CreatedTimestamp': datetime(2015, 1, 1),
'UpdatedTimestamp': datetime(2015, 1, 1),
'ChimeSdkMeetingConfiguration': {
'SourceConfiguration': {
'SelectedVideoStreams': {
'AttendeeIds': [
'string',
],
'ExternalUserIds': [
'string',
]
}
},
'ArtifactsConfiguration': {
'Audio': {
'MuxType': 'AudioOnly'|'AudioWithActiveSpeakerVideo'|'AudioWithCompositedVideo'
},
'Video': {
'State': 'Enabled'|'Disabled',
'MuxType': 'VideoOnly'
},
'Content': {
'State': 'Enabled'|'Disabled',
'MuxType': 'ContentOnly'
},
'CompositedVideo': {
'Layout': 'GridView',
'Resolution': 'HD'|'FHD',
'GridViewConfiguration': {
'ContentShareLayout': 'PresenterOnly'|'Horizontal'|'Vertical',
'PresenterOnlyConfiguration': {
'PresenterPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
}
}
}
}
}
}
}
Response Structure
(dict) --
MediaCapturePipeline (dict) --
A media pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media pipeline object.
MediaPipelineId (string) --
The ID of a media pipeline.
MediaPipelineArn (string) --
The ARN of the media capture pipeline
SourceType (string) --
Source type from which media artifacts are saved. You must use ChimeMeeting .
SourceArn (string) --
ARN of the source from which the media artifacts are saved.
Status (string) --
The status of the media pipeline.
SinkType (string) --
Destination type to which the media artifacts are saved. You must use an S3 Bucket.
SinkArn (string) --
ARN of the destination to which the media artifacts are saved.
CreatedTimestamp (datetime) --
The time at which the pipeline was created, in ISO 8601 format.
UpdatedTimestamp (datetime) --
The time at which the pipeline was updated, in ISO 8601 format.
ChimeSdkMeetingConfiguration (dict) --
The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting .
SourceConfiguration (dict) --
The source configuration for a specified media pipline.
SelectedVideoStreams (dict) --
The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.
AttendeeIds (list) --
The attendee IDs of the streams selected for a media pipeline.
ExternalUserIds (list) --
The external user IDs of the streams selected for a media pipeline.
ArtifactsConfiguration (dict) --
The configuration for the artifacts in an Amazon Chime SDK meeting.
Audio (dict) --
The configuration for the audio artifacts.
MuxType (string) --
The MUX type of the audio artifact configuration object.
Video (dict) --
The configuration for the video artifacts.
State (string) --
Indicates whether the video artifact is enabled or disabled.
MuxType (string) --
The MUX type of the video artifact configuration object.
Content (dict) --
The configuration for the content artifacts.
State (string) --
Indicates whether the content artifact is enabled or disabled.
MuxType (string) --
The MUX type of the artifact configuration.
CompositedVideo (dict) --
Enables video compositing.
Layout (string) --
The layout setting, such as GridView in the configuration object.
Resolution (string) --
The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.
GridViewConfiguration (dict) --
The GridView configuration setting.
ContentShareLayout (string) --
Defines the layout of the video tiles when content sharing is enabled.
PresenterOnlyConfiguration (dict) --
Defines the configuration options for a presenter only video tile.
PresenterPosition (string) --
Defines the position of the presenter video tile. Default: TopRight .
Exceptions
ChimeSDKMediaPipelines.Client.exceptions.BadRequestExceptionChimeSDKMediaPipelines.Client.exceptions.ForbiddenExceptionChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientExceptionChimeSDKMediaPipelines.Client.exceptions.ThrottledClientExceptionChimeSDKMediaPipelines.Client.exceptions.ResourceLimitExceededExceptionChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableExceptionChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException