[ aws . chime-sdk-media-pipelines ]

create-media-live-connector-pipeline

Description

Creates a streaming media pipeline in an Amazon Chime SDK meeting.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-media-live-connector-pipeline
--sources <value>
--sinks <value>
[--client-request-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--sources (list)

The media pipeline’s data sources.

(structure)

The data source configuration object of a streaming media pipeline.

SourceType -> (string)

The source configuration’s media source type.

ChimeSdkMeetingLiveConnectorConfiguration -> (structure)

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 -> (structure)

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 -> (structure)

The GridView configuration setting.

ContentShareLayout -> (string)

Defines the layout of the video tiles when content sharing is enabled.

PresenterOnlyConfiguration -> (structure)

Defines the configuration options for a presenter only video tile.

PresenterPosition -> (string)

Defines the position of the presenter video tile. Default: TopRight .

SourceConfiguration -> (structure)

The source configuration settings of the media pipeline’s configuration object.

SelectedVideoStreams -> (structure)

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)

JSON Syntax:

[
  {
    "SourceType": "ChimeSdkMeeting",
    "ChimeSdkMeetingLiveConnectorConfiguration": {
      "Arn": "string",
      "MuxType": "AudioWithCompositedVideo"|"AudioWithActiveSpeakerVideo",
      "CompositedVideo": {
        "Layout": "GridView",
        "Resolution": "HD"|"FHD",
        "GridViewConfiguration": {
          "ContentShareLayout": "PresenterOnly"|"Horizontal"|"Vertical",
          "PresenterOnlyConfiguration": {
            "PresenterPosition": "TopLeft"|"TopRight"|"BottomLeft"|"BottomRight"
          }
        }
      },
      "SourceConfiguration": {
        "SelectedVideoStreams": {
          "AttendeeIds": ["string", ...],
          "ExternalUserIds": ["string", ...]
        }
      }
    }
  }
  ...
]

--sinks (list)

The media pipeline’s data sinks.

(structure)

The media pipeline’s sink configuration settings.

SinkType -> (string)

The sink configuration’s sink type.

RTMPConfiguration -> (structure)

The sink configuration’s RTMP configuration setttings.

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.

Shorthand Syntax:

SinkType=string,RTMPConfiguration={Url=string,AudioChannels=string,AudioSampleRate=string} ...

JSON Syntax:

[
  {
    "SinkType": "RTMP",
    "RTMPConfiguration": {
      "Url": "string",
      "AudioChannels": "Stereo"|"Mono",
      "AudioSampleRate": "string"
    }
  }
  ...
]

--client-request-token (string)

The token assigned to the client making the request.

--tags (list)

The tags associated with the media pipeline.

(structure)

A key/value pair that grants users access to meeting resources.

Key -> (string)

The key half of a tag.

Value -> (string)

The value half of a tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

MediaLiveConnectorPipeline -> (structure)

The new media pipeline.

Sources -> (list)

The connector pipeline’s data sources.

(structure)

The data source configuration object of a streaming media pipeline.

SourceType -> (string)

The source configuration’s media source type.

ChimeSdkMeetingLiveConnectorConfiguration -> (structure)

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 -> (structure)

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 -> (structure)

The GridView configuration setting.

ContentShareLayout -> (string)

Defines the layout of the video tiles when content sharing is enabled.

PresenterOnlyConfiguration -> (structure)

Defines the configuration options for a presenter only video tile.

PresenterPosition -> (string)

Defines the position of the presenter video tile. Default: TopRight .

SourceConfiguration -> (structure)

The source configuration settings of the media pipeline’s configuration object.

SelectedVideoStreams -> (structure)

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.

(structure)

The media pipeline’s sink configuration settings.

SinkType -> (string)

The sink configuration’s sink type.

RTMPConfiguration -> (structure)

The sink configuration’s RTMP configuration setttings.

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 -> (timestamp)

Thetime at which the connector pipeline was created.

UpdatedTimestamp -> (timestamp)

The time at which the connector pipeline was last updated.