ChimeSDKMediaPipelines / Client / create_media_live_connector_pipeline

create_media_live_connector_pipeline#

ChimeSDKMediaPipelines.Client.create_media_live_connector_pipeline(**kwargs)#

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

Request Syntax

response = client.create_media_live_connector_pipeline(
    Sources=[
        {
            'SourceType': 'ChimeSdkMeeting',
            'ChimeSdkMeetingLiveConnectorConfiguration': {
                'Arn': 'string',
                'MuxType': 'AudioWithCompositedVideo'|'AudioWithActiveSpeakerVideo',
                'CompositedVideo': {
                    'Layout': 'GridView',
                    'Resolution': 'HD'|'FHD',
                    'GridViewConfiguration': {
                        'ContentShareLayout': 'PresenterOnly'|'Horizontal'|'Vertical'|'ActiveSpeakerOnly',
                        'PresenterOnlyConfiguration': {
                            'PresenterPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
                        },
                        'ActiveSpeakerOnlyConfiguration': {
                            'ActiveSpeakerPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
                        },
                        'HorizontalLayoutConfiguration': {
                            'TileOrder': 'JoinSequence'|'SpeakerSequence',
                            'TilePosition': 'Top'|'Bottom',
                            'TileCount': 123,
                            'TileAspectRatio': 'string'
                        },
                        'VerticalLayoutConfiguration': {
                            'TileOrder': 'JoinSequence'|'SpeakerSequence',
                            'TilePosition': 'Left'|'Right',
                            'TileCount': 123,
                            'TileAspectRatio': 'string'
                        },
                        'VideoAttribute': {
                            'CornerRadius': 123,
                            'BorderColor': 'Black'|'Blue'|'Red'|'Green'|'White'|'Yellow',
                            'HighlightColor': 'Black'|'Blue'|'Red'|'Green'|'White'|'Yellow',
                            'BorderThickness': 123
                        },
                        'CanvasOrientation': 'Landscape'|'Portrait'
                    }
                },
                'SourceConfiguration': {
                    'SelectedVideoStreams': {
                        'AttendeeIds': [
                            'string',
                        ],
                        'ExternalUserIds': [
                            'string',
                        ]
                    }
                }
            }
        },
    ],
    Sinks=[
        {
            'SinkType': 'RTMP',
            'RTMPConfiguration': {
                'Url': 'string',
                'AudioChannels': 'Stereo'|'Mono',
                'AudioSampleRate': 'string'
            }
        },
    ],
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

Sources (list) –
[REQUIRED]

The media live connector pipeline’s data sources.
- (dict) –
  
  The data source configuration object of a streaming media pipeline.
  - SourceType (string) – [REQUIRED]
    
    The source configuration’s media source type.
  - ChimeSdkMeetingLiveConnectorConfiguration (dict) – [REQUIRED]
    
    The configuration settings of the connector pipeline.
    - Arn (string) – [REQUIRED]
      
      The configuration object’s Chime SDK meeting ARN.
    - MuxType (string) – [REQUIRED]
      
      The configuration object’s multiplex type.
    - CompositedVideo (dict) –
      
      The media pipeline’s composited video.
      - 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) – [REQUIRED]
        
        The GridView configuration setting.
        
        ContentShareLayout (string) – [REQUIRED]
        
        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.
        
        ActiveSpeakerOnlyConfiguration (dict) –
        
        The configuration settings for an ActiveSpeakerOnly video tile.
        
        ActiveSpeakerPosition (string) –
        
        The position of the ActiveSpeakerOnly video tile.
        
        HorizontalLayoutConfiguration (dict) –
        
        The configuration settings for a horizontal layout.
        
        TileOrder (string) –
        
        Sets the automatic ordering of the video tiles.
        
        TilePosition (string) –
        
        Sets the position of horizontal tiles.
        
        TileCount (integer) –
        
        The maximum number of video tiles to display.
        
        TileAspectRatio (string) –
        
        Specifies the aspect ratio of all video tiles.
        
        VerticalLayoutConfiguration (dict) –
        
        The configuration settings for a vertical layout.
        
        TileOrder (string) –
        
        Sets the automatic ordering of the video tiles.
        
        TilePosition (string) –
        
        Sets the position of vertical tiles.
        
        TileCount (integer) –
        
        The maximum number of tiles to display.
        
        TileAspectRatio (string) –
        
        Sets the aspect ratio of the video tiles, such as 16:9.
        
        VideoAttribute (dict) –
        
        The attribute settings for the video tiles.
        
        CornerRadius (integer) –
        
        Sets the corner radius of all video tiles.
        
        BorderColor (string) –
        
        Defines the border color of all video tiles.
        
        HighlightColor (string) –
        
        Defines the highlight color for the active video tile.
        
        BorderThickness (integer) –
        
        Defines the border thickness for all video tiles.
        
        CanvasOrientation (string) –
        
        The orientation setting, horizontal or vertical.
    - SourceConfiguration (dict) –
      
      The source configuration settings of the media pipeline’s configuration object.
      - 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.
        
        (string) –
        
        ExternalUserIds (list) –
        
        The external user IDs of the streams selected for a media pipeline.
        
        (string) –
Sinks (list) –
[REQUIRED]

The media live connector pipeline’s data sinks.
- (dict) –
  
  The media pipeline’s sink configuration settings.
  - SinkType (string) – [REQUIRED]
    
    The sink configuration’s sink type.
  - RTMPConfiguration (dict) – [REQUIRED]
    
    The sink configuration’s RTMP configuration settings.
    - Url (string) – [REQUIRED]
      
      The URL of the RTMP configuration.
    - AudioChannels (string) –
      
      The audio channels set for the RTMP configuration
    - AudioSampleRate (string) –
      
      The audio sample rate set for the RTMP configuration. Default: 48000.
ClientRequestToken (string) –
The token assigned to the client making the request.

This field is autopopulated if not provided.
Tags (list) –
The tags associated with the media live connector pipeline.
- (dict) –
  
  A key/value pair that grants users access to meeting resources.
  - Key (string) – [REQUIRED]
    
    The key half of a tag.
  - Value (string) – [REQUIRED]
    
    The value half of a tag.

Return type:

dict

Returns:

Response Syntax

{
    'MediaLiveConnectorPipeline': {
        'Sources': [
            {
                'SourceType': 'ChimeSdkMeeting',
                'ChimeSdkMeetingLiveConnectorConfiguration': {
                    'Arn': 'string',
                    'MuxType': 'AudioWithCompositedVideo'|'AudioWithActiveSpeakerVideo',
                    'CompositedVideo': {
                        'Layout': 'GridView',
                        'Resolution': 'HD'|'FHD',
                        'GridViewConfiguration': {
                            'ContentShareLayout': 'PresenterOnly'|'Horizontal'|'Vertical'|'ActiveSpeakerOnly',
                            'PresenterOnlyConfiguration': {
                                'PresenterPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
                            },
                            'ActiveSpeakerOnlyConfiguration': {
                                'ActiveSpeakerPosition': 'TopLeft'|'TopRight'|'BottomLeft'|'BottomRight'
                            },
                            'HorizontalLayoutConfiguration': {
                                'TileOrder': 'JoinSequence'|'SpeakerSequence',
                                'TilePosition': 'Top'|'Bottom',
                                'TileCount': 123,
                                'TileAspectRatio': 'string'
                            },
                            'VerticalLayoutConfiguration': {
                                'TileOrder': 'JoinSequence'|'SpeakerSequence',
                                'TilePosition': 'Left'|'Right',
                                'TileCount': 123,
                                'TileAspectRatio': 'string'
                            },
                            'VideoAttribute': {
                                'CornerRadius': 123,
                                'BorderColor': 'Black'|'Blue'|'Red'|'Green'|'White'|'Yellow',
                                'HighlightColor': 'Black'|'Blue'|'Red'|'Green'|'White'|'Yellow',
                                'BorderThickness': 123
                            },
                            'CanvasOrientation': 'Landscape'|'Portrait'
                        }
                    },
                    'SourceConfiguration': {
                        'SelectedVideoStreams': {
                            'AttendeeIds': [
                                'string',
                            ],
                            'ExternalUserIds': [
                                'string',
                            ]
                        }
                    }
                }
            },
        ],
        'Sinks': [
            {
                'SinkType': 'RTMP',
                'RTMPConfiguration': {
                    'Url': 'string',
                    'AudioChannels': 'Stereo'|'Mono',
                    'AudioSampleRate': 'string'
                }
            },
        ],
        'MediaPipelineId': 'string',
        'MediaPipelineArn': 'string',
        'Status': 'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped'|'Paused'|'NotStarted',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- MediaLiveConnectorPipeline (dict) –
  
  The new media live connector pipeline.
  - Sources (list) –
    
    The connector pipeline’s data sources.
    - (dict) –
      
      The data source configuration object of a streaming media pipeline.
      - SourceType (string) –
        
        The source configuration’s media source type.
      - ChimeSdkMeetingLiveConnectorConfiguration (dict) –
        
        The configuration settings of the connector pipeline.
        
        Arn (string) –
        
        The configuration object’s Chime SDK meeting ARN.
        
        MuxType (string) –
        
        The configuration object’s multiplex type.
        
        CompositedVideo (dict) –
        
        The media pipeline’s composited video.
        
        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.
        
        ActiveSpeakerOnlyConfiguration (dict) –
        
        The configuration settings for an ActiveSpeakerOnly video tile.
        
        ActiveSpeakerPosition (string) –
        
        The position of the ActiveSpeakerOnly video tile.
        
        HorizontalLayoutConfiguration (dict) –
        
        The configuration settings for a horizontal layout.
        
        TileOrder (string) –
        
        Sets the automatic ordering of the video tiles.
        
        TilePosition (string) –
        
        Sets the position of horizontal tiles.
        
        TileCount (integer) –
        
        The maximum number of video tiles to display.
        
        TileAspectRatio (string) –
        
        Specifies the aspect ratio of all video tiles.
        
        VerticalLayoutConfiguration (dict) –
        
        The configuration settings for a vertical layout.
        
        TileOrder (string) –
        
        Sets the automatic ordering of the video tiles.
        
        TilePosition (string) –
        
        Sets the position of vertical tiles.
        
        TileCount (integer) –
        
        The maximum number of tiles to display.
        
        TileAspectRatio (string) –
        
        Sets the aspect ratio of the video tiles, such as 16:9.
        
        VideoAttribute (dict) –
        
        The attribute settings for the video tiles.
        
        CornerRadius (integer) –
        
        Sets the corner radius of all video tiles.
        
        BorderColor (string) –
        
        Defines the border color of all video tiles.
        
        HighlightColor (string) –
        
        Defines the highlight color for the active video tile.
        
        BorderThickness (integer) –
        
        Defines the border thickness for all video tiles.
        
        CanvasOrientation (string) –
        
        The orientation setting, horizontal or vertical.
        
        SourceConfiguration (dict) –
        
        The source configuration settings of the media pipeline’s configuration object.
        
        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.
        
        (string) –
        
        ExternalUserIds (list) –
        
        The external user IDs of the streams selected for a media pipeline.
        
        (string) –
  - Sinks (list) –
    
    The connector pipeline’s data sinks.
    - (dict) –
      
      The media pipeline’s sink configuration settings.
      - SinkType (string) –
        
        The sink configuration’s sink type.
      - RTMPConfiguration (dict) –
        
        The sink configuration’s RTMP configuration settings.
        
        Url (string) –
        
        The URL of the RTMP configuration.
        
        AudioChannels (string) –
        
        The audio channels set for the RTMP configuration
        
        AudioSampleRate (string) –
        
        The audio sample rate set for the RTMP configuration. Default: 48000.
  - MediaPipelineId (string) –
    
    The connector pipeline’s ID.
  - MediaPipelineArn (string) –
    
    The connector pipeline’s ARN.
  - Status (string) –
    
    The connector pipeline’s status.
  - CreatedTimestamp (datetime) –
    
    The time at which the connector pipeline was created.
  - UpdatedTimestamp (datetime) –
    
    The time at which the connector pipeline was last updated.

Exceptions

ChimeSDKMediaPipelines.Client.exceptions.BadRequestException
ChimeSDKMediaPipelines.Client.exceptions.ForbiddenException
ChimeSDKMediaPipelines.Client.exceptions.UnauthorizedClientException
ChimeSDKMediaPipelines.Client.exceptions.ThrottledClientException
ChimeSDKMediaPipelines.Client.exceptions.ResourceLimitExceededException
ChimeSDKMediaPipelines.Client.exceptions.ServiceUnavailableException
ChimeSDKMediaPipelines.Client.exceptions.ServiceFailureException