You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.ChimeSDKMediaPipelines

Inherits:
AWS.Service show all
Identifier:
chimesdkmediapipelines
API Version:
2021-07-15
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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 pipleines, see Amazon Chime SDK media pipelines.

Sending a Request Using ChimeSDKMediaPipelines

var chimesdkmediapipelines = new AWS.ChimeSDKMediaPipelines();
chimesdkmediapipelines.createMediaCapturePipeline(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ChimeSDKMediaPipelines object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var chimesdkmediapipelines = new AWS.ChimeSDKMediaPipelines({apiVersion: '2021-07-15'});

You can also set the API version globally in AWS.config.apiVersions using the chimesdkmediapipelines service identifier:

AWS.config.apiVersions = {
  chimesdkmediapipelines: '2021-07-15',
  // other service API versions
};

var chimesdkmediapipelines = new AWS.ChimeSDKMediaPipelines();

Version:

  • 2021-07-15

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ChimeSDKMediaPipelines(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ChimeSDKMediaPipelines object

var chimesdkmediapipelines = new AWS.ChimeSDKMediaPipelines({apiVersion: '2021-07-15'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.ChimeSDKMediaPipelines.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.ChimeSDKMediaPipelines.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.ChimeSDKMediaPipelines.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createMediaCapturePipeline(params = {}, callback) ⇒ AWS.Request

Creates a media pipeline.

Service Reference:

Examples:

Calling the createMediaCapturePipeline operation

var params = {
  SinkArn: 'STRING_VALUE', /* required */
  SinkType: S3Bucket, /* required */
  SourceArn: 'STRING_VALUE', /* required */
  SourceType: ChimeSdkMeeting, /* required */
  ChimeSdkMeetingConfiguration: {
    ArtifactsConfiguration: {
      Audio: { /* required */
        MuxType: AudioOnly | AudioWithActiveSpeakerVideo | AudioWithCompositedVideo /* required */
      },
      Content: { /* required */
        State: Enabled | Disabled, /* required */
        MuxType: ContentOnly
      },
      Video: { /* required */
        State: Enabled | Disabled, /* required */
        MuxType: VideoOnly
      },
      CompositedVideo: {
        GridViewConfiguration: { /* required */
          ContentShareLayout: PresenterOnly | Horizontal | Vertical, /* required */
          PresenterOnlyConfiguration: {
            PresenterPosition: TopLeft | TopRight | BottomLeft | BottomRight
          }
        },
        Layout: GridView,
        Resolution: HD | FHD
      }
    },
    SourceConfiguration: {
      SelectedVideoStreams: {
        AttendeeIds: [
          'STRING_VALUE',
          /* more items */
        ],
        ExternalUserIds: [
          'STRING_VALUE',
          /* more items */
        ]
      }
    }
  },
  ClientRequestToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkmediapipelines.createMediaCapturePipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • SourceType — (String)

      Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

      Possible values include:
      • "ChimeSdkMeeting"
    • SourceArn — (String)

      ARN of the source from which the media artifacts are captured.

    • SinkType — (String)

      Destination type to which the media artifacts are saved. You must use an S3 bucket.

      Possible values include:
      • "S3Bucket"
    • SinkArn — (String)

      The ARN of the sink type.

    • ClientRequestToken — (String)

      The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • ChimeSdkMeetingConfiguration — (map)

      The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

      • SourceConfiguration — (map)

        The source configuration for a specified media pipline.

        • SelectedVideoStreams — (map)

          The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.

          • AttendeeIds — (Array<String>)

            The attendee IDs of the streams selected for a media pipeline.

          • ExternalUserIds — (Array<String>)

            The external user IDs of the streams selected for a media pipeline.

      • ArtifactsConfiguration — (map)

        The configuration for the artifacts in an Amazon Chime SDK meeting.

        • Audiorequired — (map)

          The configuration for the audio artifacts.

          • MuxTyperequired — (String)

            The MUX type of the audio artifact configuration object.

            Possible values include:
            • "AudioOnly"
            • "AudioWithActiveSpeakerVideo"
            • "AudioWithCompositedVideo"
        • Videorequired — (map)

          The configuration for the video artifacts.

          • Staterequired — (String)

            Indicates whether the video artifact is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
          • MuxType — (String)

            The MUX type of the video artifact configuration object.

            Possible values include:
            • "VideoOnly"
        • Contentrequired — (map)

          The configuration for the content artifacts.

          • Staterequired — (String)

            Indicates whether the content artifact is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
          • MuxType — (String)

            The MUX type of the artifact configuration.

            Possible values include:
            • "ContentOnly"
        • CompositedVideo — (map)

          Enables video compositing.

          • Layout — (String)

            The layout setting, such as GridView in the configuration object.

            Possible values include:
            • "GridView"
          • Resolution — (String)

            The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

            Possible values include:
            • "HD"
            • "FHD"
          • GridViewConfigurationrequired — (map)

            The GridView configuration setting.

            • ContentShareLayoutrequired — (String)

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

              Possible values include:
              • "PresenterOnly"
              • "Horizontal"
              • "Vertical"
            • PresenterOnlyConfiguration — (map)

              Defines the configuration options for a presenter only video tile.

              • PresenterPosition — (String)

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

                Possible values include:
                • "TopLeft"
                • "TopRight"
                • "BottomLeft"
                • "BottomRight"
    • Tags — (Array<map>)

      The tag key-value pairs.

      • Keyrequired — (String)

        The key half of a tag.

      • Valuerequired — (String)

        The value half of a tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MediaCapturePipeline — (map)

        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.

          Possible values include:
          • "ChimeSdkMeeting"
        • SourceArn — (String)

          ARN of the source from which the media artifacts are saved.

        • Status — (String)

          The status of the media pipeline.

          Possible values include:
          • "Initializing"
          • "InProgress"
          • "Failed"
          • "Stopping"
          • "Stopped"
        • SinkType — (String)

          Destination type to which the media artifacts are saved. You must use an S3 Bucket.

          Possible values include:
          • "S3Bucket"
        • SinkArn — (String)

          ARN of the destination to which the media artifacts are saved.

        • CreatedTimestamp — (Date)

          The time at which the pipeline was created, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the pipeline was updated, in ISO 8601 format.

        • ChimeSdkMeetingConfiguration — (map)

          The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

          • SourceConfiguration — (map)

            The source configuration for a specified media pipline.

            • SelectedVideoStreams — (map)

              The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.

              • AttendeeIds — (Array<String>)

                The attendee IDs of the streams selected for a media pipeline.

              • ExternalUserIds — (Array<String>)

                The external user IDs of the streams selected for a media pipeline.

          • ArtifactsConfiguration — (map)

            The configuration for the artifacts in an Amazon Chime SDK meeting.

            • Audiorequired — (map)

              The configuration for the audio artifacts.

              • MuxTyperequired — (String)

                The MUX type of the audio artifact configuration object.

                Possible values include:
                • "AudioOnly"
                • "AudioWithActiveSpeakerVideo"
                • "AudioWithCompositedVideo"
            • Videorequired — (map)

              The configuration for the video artifacts.

              • Staterequired — (String)

                Indicates whether the video artifact is enabled or disabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
              • MuxType — (String)

                The MUX type of the video artifact configuration object.

                Possible values include:
                • "VideoOnly"
            • Contentrequired — (map)

              The configuration for the content artifacts.

              • Staterequired — (String)

                Indicates whether the content artifact is enabled or disabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
              • MuxType — (String)

                The MUX type of the artifact configuration.

                Possible values include:
                • "ContentOnly"
            • CompositedVideo — (map)

              Enables video compositing.

              • Layout — (String)

                The layout setting, such as GridView in the configuration object.

                Possible values include:
                • "GridView"
              • Resolution — (String)

                The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

                Possible values include:
                • "HD"
                • "FHD"
              • GridViewConfigurationrequired — (map)

                The GridView configuration setting.

                • ContentShareLayoutrequired — (String)

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

                  Possible values include:
                  • "PresenterOnly"
                  • "Horizontal"
                  • "Vertical"
                • PresenterOnlyConfiguration — (map)

                  Defines the configuration options for a presenter only video tile.

                  • PresenterPosition — (String)

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

                    Possible values include:
                    • "TopLeft"
                    • "TopRight"
                    • "BottomLeft"
                    • "BottomRight"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createMediaConcatenationPipeline(params = {}, callback) ⇒ AWS.Request

Creates a media concatenation pipeline.

Examples:

Calling the createMediaConcatenationPipeline operation

var params = {
  Sinks: [ /* required */
    {
      S3BucketSinkConfiguration: { /* required */
        Destination: 'STRING_VALUE' /* required */
      },
      Type: S3Bucket /* required */
    },
    /* more items */
  ],
  Sources: [ /* required */
    {
      MediaCapturePipelineSourceConfiguration: { /* required */
        ChimeSdkMeetingConfiguration: { /* required */
          ArtifactsConfiguration: { /* required */
            Audio: { /* required */
              State: Enabled /* required */
            },
            CompositedVideo: { /* required */
              State: Enabled | Disabled /* required */
            },
            Content: { /* required */
              State: Enabled | Disabled /* required */
            },
            DataChannel: { /* required */
              State: Enabled | Disabled /* required */
            },
            MeetingEvents: { /* required */
              State: Enabled | Disabled /* required */
            },
            TranscriptionMessages: { /* required */
              State: Enabled | Disabled /* required */
            },
            Video: { /* required */
              State: Enabled | Disabled /* required */
            }
          }
        },
        MediaPipelineArn: 'STRING_VALUE' /* required */
      },
      Type: MediaCapturePipeline /* required */
    },
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkmediapipelines.createMediaConcatenationPipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Sources — (Array<map>)

      An object that specifies the sources for the media concatenation pipeline.

      • Typerequired — (String)

        The type of concatenation source in a configuration object.

        Possible values include:
        • "MediaCapturePipeline"
      • MediaCapturePipelineSourceConfigurationrequired — (map)

        The concatenation settings for the media pipeline in a configuration object.

        • MediaPipelineArnrequired — (String)

          The media pipeline ARN in the configuration object of a media capture pipeline.

        • ChimeSdkMeetingConfigurationrequired — (map)

          The meeting configuration settings in a media capture pipeline configuration object.

          • ArtifactsConfigurationrequired — (map)

            The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.

            • Audiorequired — (map)

              The configuration for the audio artifacts concatenation.

              • Staterequired — (String)

                Enables the name object, where name is the name of the configuration object, such as AudioConcatenation.

                Possible values include:
                • "Enabled"
            • Videorequired — (map)

              The configuration for the video artifacts concatenation.

              • Staterequired — (String)

                Enables or disables the configuration object.

                Possible values include:
                • "Enabled"
                • "Disabled"
            • Contentrequired — (map)

              The configuration for the content artifacts concatenation.

              • Staterequired — (String)

                Enables or disables the configuration object.

                Possible values include:
                • "Enabled"
                • "Disabled"
            • DataChannelrequired — (map)

              The configuration for the data channel artifacts concatenation.

              • Staterequired — (String)

                Enables or disables the configuration object.

                Possible values include:
                • "Enabled"
                • "Disabled"
            • TranscriptionMessagesrequired — (map)

              The configuration for the transcription messages artifacts concatenation.

              • Staterequired — (String)

                Enables or disables the configuration object.

                Possible values include:
                • "Enabled"
                • "Disabled"
            • MeetingEventsrequired — (map)

              The configuration for the meeting events artifacts concatenation.

              • Staterequired — (String)

                Enables or disables the configuration object.

                Possible values include:
                • "Enabled"
                • "Disabled"
            • CompositedVideorequired — (map)

              The configuration for the composited video artifacts concatenation.

              • Staterequired — (String)

                Enables or disables the configuration object.

                Possible values include:
                • "Enabled"
                • "Disabled"
    • Sinks — (Array<map>)

      An object that specifies the data sinks for the media concatenation pipeline.

      • Typerequired — (String)

        The type of data sink in the configuration object.

        Possible values include:
        • "S3Bucket"
      • S3BucketSinkConfigurationrequired — (map)

        The configuration settings for an Amazon S3 bucket sink.

        • Destinationrequired — (String)

          The destination URL of the S3 bucket.

    • ClientRequestToken — (String)

      The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media concatenation pipeline request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      The tags associated with the media concatenation pipeline.

      • Keyrequired — (String)

        The key half of a tag.

      • Valuerequired — (String)

        The value half of a tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MediaConcatenationPipeline — (map)

        A media concatenation pipeline object, the ID, source type, MediaPipelineARN, and sink of a media concatenation pipeline object.

        • MediaPipelineId — (String)

          The ID of the media pipeline being concatenated.

        • MediaPipelineArn — (String)

          The ARN of the media pipeline that you specify in the SourceConfiguration object.

        • Sources — (Array<map>)

          The data sources being concatnated.

          • Typerequired — (String)

            The type of concatenation source in a configuration object.

            Possible values include:
            • "MediaCapturePipeline"
          • MediaCapturePipelineSourceConfigurationrequired — (map)

            The concatenation settings for the media pipeline in a configuration object.

            • MediaPipelineArnrequired — (String)

              The media pipeline ARN in the configuration object of a media capture pipeline.

            • ChimeSdkMeetingConfigurationrequired — (map)

              The meeting configuration settings in a media capture pipeline configuration object.

              • ArtifactsConfigurationrequired — (map)

                The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.

                • Audiorequired — (map)

                  The configuration for the audio artifacts concatenation.

                  • Staterequired — (String)

                    Enables the name object, where name is the name of the configuration object, such as AudioConcatenation.

                    Possible values include:
                    • "Enabled"
                • Videorequired — (map)

                  The configuration for the video artifacts concatenation.

                  • Staterequired — (String)

                    Enables or disables the configuration object.

                    Possible values include:
                    • "Enabled"
                    • "Disabled"
                • Contentrequired — (map)

                  The configuration for the content artifacts concatenation.

                  • Staterequired — (String)

                    Enables or disables the configuration object.

                    Possible values include:
                    • "Enabled"
                    • "Disabled"
                • DataChannelrequired — (map)

                  The configuration for the data channel artifacts concatenation.

                  • Staterequired — (String)

                    Enables or disables the configuration object.

                    Possible values include:
                    • "Enabled"
                    • "Disabled"
                • TranscriptionMessagesrequired — (map)

                  The configuration for the transcription messages artifacts concatenation.

                  • Staterequired — (String)

                    Enables or disables the configuration object.

                    Possible values include:
                    • "Enabled"
                    • "Disabled"
                • MeetingEventsrequired — (map)

                  The configuration for the meeting events artifacts concatenation.

                  • Staterequired — (String)

                    Enables or disables the configuration object.

                    Possible values include:
                    • "Enabled"
                    • "Disabled"
                • CompositedVideorequired — (map)

                  The configuration for the composited video artifacts concatenation.

                  • Staterequired — (String)

                    Enables or disables the configuration object.

                    Possible values include:
                    • "Enabled"
                    • "Disabled"
        • Sinks — (Array<map>)

          The data sinks of the concatenation pipeline.

          • Typerequired — (String)

            The type of data sink in the configuration object.

            Possible values include:
            • "S3Bucket"
          • S3BucketSinkConfigurationrequired — (map)

            The configuration settings for an Amazon S3 bucket sink.

            • Destinationrequired — (String)

              The destination URL of the S3 bucket.

        • Status — (String)

          The status of the concatenation pipeline.

          Possible values include:
          • "Initializing"
          • "InProgress"
          • "Failed"
          • "Stopping"
          • "Stopped"
        • CreatedTimestamp — (Date)

          The time at which the concatenation pipeline was created.

        • UpdatedTimestamp — (Date)

          The time at which the concatenation pipeline was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createMediaLiveConnectorPipeline(params = {}, callback) ⇒ AWS.Request

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

Examples:

Calling the createMediaLiveConnectorPipeline operation

var params = {
  Sinks: [ /* required */
    {
      RTMPConfiguration: { /* required */
        Url: 'STRING_VALUE', /* required */
        AudioChannels: Stereo | Mono,
        AudioSampleRate: 'STRING_VALUE'
      },
      SinkType: RTMP /* required */
    },
    /* more items */
  ],
  Sources: [ /* required */
    {
      ChimeSdkMeetingLiveConnectorConfiguration: { /* required */
        Arn: 'STRING_VALUE', /* required */
        MuxType: AudioWithCompositedVideo | AudioWithActiveSpeakerVideo, /* required */
        CompositedVideo: {
          GridViewConfiguration: { /* required */
            ContentShareLayout: PresenterOnly | Horizontal | Vertical, /* required */
            PresenterOnlyConfiguration: {
              PresenterPosition: TopLeft | TopRight | BottomLeft | BottomRight
            }
          },
          Layout: GridView,
          Resolution: HD | FHD
        },
        SourceConfiguration: {
          SelectedVideoStreams: {
            AttendeeIds: [
              'STRING_VALUE',
              /* more items */
            ],
            ExternalUserIds: [
              'STRING_VALUE',
              /* more items */
            ]
          }
        }
      },
      SourceType: ChimeSdkMeeting /* required */
    },
    /* more items */
  ],
  ClientRequestToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkmediapipelines.createMediaLiveConnectorPipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Sources — (Array<map>)

      The media pipeline's data sources.

      • SourceTyperequired — (String)

        The source configuration's media source type.

        Possible values include:
        • "ChimeSdkMeeting"
      • ChimeSdkMeetingLiveConnectorConfigurationrequired — (map)

        The configuration settings of the connector pipeline.

        • Arnrequired — (String)

          The configuration object's Chime SDK meeting ARN.

        • MuxTyperequired — (String)

          The configuration object's multiplex type.

          Possible values include:
          • "AudioWithCompositedVideo"
          • "AudioWithActiveSpeakerVideo"
        • CompositedVideo — (map)

          The media pipeline's composited video.

          • Layout — (String)

            The layout setting, such as GridView in the configuration object.

            Possible values include:
            • "GridView"
          • Resolution — (String)

            The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

            Possible values include:
            • "HD"
            • "FHD"
          • GridViewConfigurationrequired — (map)

            The GridView configuration setting.

            • ContentShareLayoutrequired — (String)

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

              Possible values include:
              • "PresenterOnly"
              • "Horizontal"
              • "Vertical"
            • PresenterOnlyConfiguration — (map)

              Defines the configuration options for a presenter only video tile.

              • PresenterPosition — (String)

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

                Possible values include:
                • "TopLeft"
                • "TopRight"
                • "BottomLeft"
                • "BottomRight"
        • SourceConfiguration — (map)

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

          • SelectedVideoStreams — (map)

            The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.

            • AttendeeIds — (Array<String>)

              The attendee IDs of the streams selected for a media pipeline.

            • ExternalUserIds — (Array<String>)

              The external user IDs of the streams selected for a media pipeline.

    • Sinks — (Array<map>)

      The media pipeline's data sinks.

      • SinkTyperequired — (String)

        The sink configuration's sink type.

        Possible values include:
        • "RTMP"
      • RTMPConfigurationrequired — (map)

        The sink configuration's RTMP configuration setttings.

        • Urlrequired — (String)

          The URL of the RTMP configuration.

        • AudioChannels — (String)

          The audio channels set for the RTMP configuration

          Possible values include:
          • "Stereo"
          • "Mono"
        • AudioSampleRate — (String)

          The audio sample rate set for the RTMP configuration. Default: 48000.

    • ClientRequestToken — (String)

      The token assigned to the client making the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      The tags associated with the media pipeline.

      • Keyrequired — (String)

        The key half of a tag.

      • Valuerequired — (String)

        The value half of a tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MediaLiveConnectorPipeline — (map)

        The new media pipeline.

        • Sources — (Array<map>)

          The connector pipeline's data sources.

          • SourceTyperequired — (String)

            The source configuration's media source type.

            Possible values include:
            • "ChimeSdkMeeting"
          • ChimeSdkMeetingLiveConnectorConfigurationrequired — (map)

            The configuration settings of the connector pipeline.

            • Arnrequired — (String)

              The configuration object's Chime SDK meeting ARN.

            • MuxTyperequired — (String)

              The configuration object's multiplex type.

              Possible values include:
              • "AudioWithCompositedVideo"
              • "AudioWithActiveSpeakerVideo"
            • CompositedVideo — (map)

              The media pipeline's composited video.

              • Layout — (String)

                The layout setting, such as GridView in the configuration object.

                Possible values include:
                • "GridView"
              • Resolution — (String)

                The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

                Possible values include:
                • "HD"
                • "FHD"
              • GridViewConfigurationrequired — (map)

                The GridView configuration setting.

                • ContentShareLayoutrequired — (String)

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

                  Possible values include:
                  • "PresenterOnly"
                  • "Horizontal"
                  • "Vertical"
                • PresenterOnlyConfiguration — (map)

                  Defines the configuration options for a presenter only video tile.

                  • PresenterPosition — (String)

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

                    Possible values include:
                    • "TopLeft"
                    • "TopRight"
                    • "BottomLeft"
                    • "BottomRight"
            • SourceConfiguration — (map)

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

              • SelectedVideoStreams — (map)

                The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.

                • AttendeeIds — (Array<String>)

                  The attendee IDs of the streams selected for a media pipeline.

                • ExternalUserIds — (Array<String>)

                  The external user IDs of the streams selected for a media pipeline.

        • Sinks — (Array<map>)

          The connector pipeline's data sinks.

          • SinkTyperequired — (String)

            The sink configuration's sink type.

            Possible values include:
            • "RTMP"
          • RTMPConfigurationrequired — (map)

            The sink configuration's RTMP configuration setttings.

            • Urlrequired — (String)

              The URL of the RTMP configuration.

            • AudioChannels — (String)

              The audio channels set for the RTMP configuration

              Possible values include:
              • "Stereo"
              • "Mono"
            • 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.

          Possible values include:
          • "Initializing"
          • "InProgress"
          • "Failed"
          • "Stopping"
          • "Stopped"
        • CreatedTimestamp — (Date)

          Thetime at which the connector pipeline was created.

        • UpdatedTimestamp — (Date)

          The time at which the connector pipeline was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteMediaCapturePipeline(params = {}, callback) ⇒ AWS.Request

Deletes the media pipeline.

Service Reference:

Examples:

Calling the deleteMediaCapturePipeline operation

var params = {
  MediaPipelineId: 'STRING_VALUE' /* required */
};
chimesdkmediapipelines.deleteMediaCapturePipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MediaPipelineId — (String)

      The ID of the media pipeline being deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteMediaPipeline(params = {}, callback) ⇒ AWS.Request

Deletes the media pipeline.

Service Reference:

Examples:

Calling the deleteMediaPipeline operation

var params = {
  MediaPipelineId: 'STRING_VALUE' /* required */
};
chimesdkmediapipelines.deleteMediaPipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MediaPipelineId — (String)

      The ID of the media pipeline to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getMediaCapturePipeline(params = {}, callback) ⇒ AWS.Request

Gets an existing media pipeline.

Service Reference:

Examples:

Calling the getMediaCapturePipeline operation

var params = {
  MediaPipelineId: 'STRING_VALUE' /* required */
};
chimesdkmediapipelines.getMediaCapturePipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MediaPipelineId — (String)

      The ID of the pipeline that you want to get.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MediaCapturePipeline — (map)

        The 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.

          Possible values include:
          • "ChimeSdkMeeting"
        • SourceArn — (String)

          ARN of the source from which the media artifacts are saved.

        • Status — (String)

          The status of the media pipeline.

          Possible values include:
          • "Initializing"
          • "InProgress"
          • "Failed"
          • "Stopping"
          • "Stopped"
        • SinkType — (String)

          Destination type to which the media artifacts are saved. You must use an S3 Bucket.

          Possible values include:
          • "S3Bucket"
        • SinkArn — (String)

          ARN of the destination to which the media artifacts are saved.

        • CreatedTimestamp — (Date)

          The time at which the pipeline was created, in ISO 8601 format.

        • UpdatedTimestamp — (Date)

          The time at which the pipeline was updated, in ISO 8601 format.

        • ChimeSdkMeetingConfiguration — (map)

          The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

          • SourceConfiguration — (map)

            The source configuration for a specified media pipline.

            • SelectedVideoStreams — (map)

              The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.

              • AttendeeIds — (Array<String>)

                The attendee IDs of the streams selected for a media pipeline.

              • ExternalUserIds — (Array<String>)

                The external user IDs of the streams selected for a media pipeline.

          • ArtifactsConfiguration — (map)

            The configuration for the artifacts in an Amazon Chime SDK meeting.

            • Audiorequired — (map)

              The configuration for the audio artifacts.

              • MuxTyperequired — (String)

                The MUX type of the audio artifact configuration object.

                Possible values include:
                • "AudioOnly"
                • "AudioWithActiveSpeakerVideo"
                • "AudioWithCompositedVideo"
            • Videorequired — (map)

              The configuration for the video artifacts.

              • Staterequired — (String)

                Indicates whether the video artifact is enabled or disabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
              • MuxType — (String)

                The MUX type of the video artifact configuration object.

                Possible values include:
                • "VideoOnly"
            • Contentrequired — (map)

              The configuration for the content artifacts.

              • Staterequired — (String)

                Indicates whether the content artifact is enabled or disabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
              • MuxType — (String)

                The MUX type of the artifact configuration.

                Possible values include:
                • "ContentOnly"
            • CompositedVideo — (map)

              Enables video compositing.

              • Layout — (String)

                The layout setting, such as GridView in the configuration object.

                Possible values include:
                • "GridView"
              • Resolution — (String)

                The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

                Possible values include:
                • "HD"
                • "FHD"
              • GridViewConfigurationrequired — (map)

                The GridView configuration setting.

                • ContentShareLayoutrequired — (String)

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

                  Possible values include:
                  • "PresenterOnly"
                  • "Horizontal"
                  • "Vertical"
                • PresenterOnlyConfiguration — (map)

                  Defines the configuration options for a presenter only video tile.

                  • PresenterPosition — (String)

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

                    Possible values include:
                    • "TopLeft"
                    • "TopRight"
                    • "BottomLeft"
                    • "BottomRight"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getMediaPipeline(params = {}, callback) ⇒ AWS.Request

Gets an existing media pipeline.

Service Reference:

Examples:

Calling the getMediaPipeline operation

var params = {
  MediaPipelineId: 'STRING_VALUE' /* required */
};
chimesdkmediapipelines.getMediaPipeline(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MediaPipelineId — (String)

      The ID of the pipeline that you want to get.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MediaPipeline — (map)

        The media pipeline object.

        • MediaCapturePipeline — (map)

          A pipeline that enables users to capture audio and video.

          • 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.

            Possible values include:
            • "ChimeSdkMeeting"
          • SourceArn — (String)

            ARN of the source from which the media artifacts are saved.

          • Status — (String)

            The status of the media pipeline.

            Possible values include:
            • "Initializing"
            • "InProgress"
            • "Failed"
            • "Stopping"
            • "Stopped"
          • SinkType — (String)

            Destination type to which the media artifacts are saved. You must use an S3 Bucket.

            Possible values include:
            • "S3Bucket"
          • SinkArn — (String)

            ARN of the destination to which the media artifacts are saved.

          • CreatedTimestamp — (Date)

            The time at which the pipeline was created, in ISO 8601 format.

          • UpdatedTimestamp — (Date)

            The time at which the pipeline was updated, in ISO 8601 format.

          • ChimeSdkMeetingConfiguration — (map)

            The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

            • SourceConfiguration — (map)

              The source configuration for a specified media pipline.

              • SelectedVideoStreams — (map)

                The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.

                • AttendeeIds — (Array<String>)

                  The attendee IDs of the streams selected for a media pipeline.

                • ExternalUserIds — (Array<String>)

                  The external user IDs of the streams selected for a media pipeline.

            • ArtifactsConfiguration — (map)

              The configuration for the artifacts in an Amazon Chime SDK meeting.

              • Audiorequired — (map)

                The configuration for the audio artifacts.

                • MuxTyperequired — (String)

                  The MUX type of the audio artifact configuration object.

                  Possible values include:
                  • "AudioOnly"
                  • "AudioWithActiveSpeakerVideo"
                  • "AudioWithCompositedVideo"
              • Videorequired — (map)

                The configuration for the video artifacts.

                • Staterequired — (String)

                  Indicates whether the video artifact is enabled or disabled.

                  Possible values include:
                  • "Enabled"
                  • "Disabled"
                • MuxType — (String)

                  The MUX type of the video artifact configuration object.

                  Possible values include:
                  • "VideoOnly"
              • Contentrequired — (map)

                The configuration for the content artifacts.

                • Staterequired — (String)

                  Indicates whether the content artifact is enabled or disabled.

                  Possible values include:
                  • "Enabled"
                  • "Disabled"
                • MuxType — (String)

                  The MUX type of the artifact configuration.

                  Possible values include:
                  • "ContentOnly"
              • CompositedVideo — (map)

                Enables video compositing.

                • Layout — (String)

                  The layout setting, such as GridView in the configuration object.

                  Possible values include:
                  • "GridView"
                • Resolution — (String)

                  The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

                  Possible values include:
                  • "HD"
                  • "FHD"
                • GridViewConfigurationrequired — (map)

                  The GridView configuration setting.

                  • ContentShareLayoutrequired — (String)

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

                    Possible values include:
                    • "PresenterOnly"
                    • "Horizontal"
                    • "Vertical"
                  • PresenterOnlyConfiguration — (map)

                    Defines the configuration options for a presenter only video tile.

                    • PresenterPosition — (String)

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

                      Possible values include:
                      • "TopLeft"
                      • "TopRight"
                      • "BottomLeft"
                      • "BottomRight"
        • MediaLiveConnectorPipeline — (map)

          The connector pipeline of the media pipeline.

          • Sources — (Array<map>)

            The connector pipeline's data sources.

            • SourceTyperequired — (String)

              The source configuration's media source type.

              Possible values include:
              • "ChimeSdkMeeting"
            • ChimeSdkMeetingLiveConnectorConfigurationrequired — (map)

              The configuration settings of the connector pipeline.

              • Arnrequired — (String)

                The configuration object's Chime SDK meeting ARN.

              • MuxTyperequired — (String)

                The configuration object's multiplex type.

                Possible values include:
                • "AudioWithCompositedVideo"
                • "AudioWithActiveSpeakerVideo"
              • CompositedVideo — (map)

                The media pipeline's composited video.

                • Layout — (String)

                  The layout setting, such as GridView in the configuration object.

                  Possible values include:
                  • "GridView"
                • Resolution — (String)

                  The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

                  Possible values include:
                  • "HD"
                  • "FHD"
                • GridViewConfigurationrequired — (map)

                  The GridView configuration setting.

                  • ContentShareLayoutrequired — (String)

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

                    Possible values include:
                    • "PresenterOnly"
                    • "Horizontal"
                    • "Vertical"
                  • PresenterOnlyConfiguration — (map)

                    Defines the configuration options for a presenter only video tile.

                    • PresenterPosition — (String)

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

                      Possible values include:
                      • "TopLeft"
                      • "TopRight"
                      • "BottomLeft"
                      • "BottomRight"
              • SourceConfiguration — (map)

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

                • SelectedVideoStreams — (map)

                  The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.

                  • AttendeeIds — (Array<String>)

                    The attendee IDs of the streams selected for a media pipeline.

                  • ExternalUserIds — (Array<String>)

                    The external user IDs of the streams selected for a media pipeline.

          • Sinks — (Array<map>)

            The connector pipeline's data sinks.

            • SinkTyperequired — (String)

              The sink configuration's sink type.

              Possible values include:
              • "RTMP"
            • RTMPConfigurationrequired — (map)

              The sink configuration's RTMP configuration setttings.

              • Urlrequired — (String)

                The URL of the RTMP configuration.

              • AudioChannels — (String)

                The audio channels set for the RTMP configuration

                Possible values include:
                • "Stereo"
                • "Mono"
              • 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.

            Possible values include:
            • "Initializing"
            • "InProgress"
            • "Failed"
            • "Stopping"
            • "Stopped"
          • CreatedTimestamp — (Date)

            Thetime at which the connector pipeline was created.

          • UpdatedTimestamp — (Date)

            The time at which the connector pipeline was last updated.

        • MediaConcatenationPipeline — (map)

          The media concatenation pipeline in a media pipeline.

          • MediaPipelineId — (String)

            The ID of the media pipeline being concatenated.

          • MediaPipelineArn — (String)

            The ARN of the media pipeline that you specify in the SourceConfiguration object.

          • Sources — (Array<map>)

            The data sources being concatnated.

            • Typerequired — (String)

              The type of concatenation source in a configuration object.

              Possible values include:
              • "MediaCapturePipeline"
            • MediaCapturePipelineSourceConfigurationrequired — (map)

              The concatenation settings for the media pipeline in a configuration object.

              • MediaPipelineArnrequired — (String)

                The media pipeline ARN in the configuration object of a media capture pipeline.

              • ChimeSdkMeetingConfigurationrequired — (map)

                The meeting configuration settings in a media capture pipeline configuration object.

                • ArtifactsConfigurationrequired — (map)

                  The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.

                  • Audiorequired — (map)

                    The configuration for the audio artifacts concatenation.

                    • Staterequired — (String)

                      Enables the name object, where name is the name of the configuration object, such as AudioConcatenation.

                      Possible values include:
                      • "Enabled"
                  • Videorequired — (map)

                    The configuration for the video artifacts concatenation.

                    • Staterequired — (String)

                      Enables or disables the configuration object.

                      Possible values include:
                      • "Enabled"
                      • "Disabled"
                  • Contentrequired — (map)

                    The configuration for the content artifacts concatenation.

                    • Staterequired — (String)

                      Enables or disables the configuration object.

                      Possible values include:
                      • "Enabled"
                      • "Disabled"
                  • DataChannelrequired — (map)

                    The configuration for the data channel artifacts concatenation.

                    • Staterequired — (String)

                      Enables or disables the configuration object.

                      Possible values include:
                      • "Enabled"
                      • "Disabled"
                  • TranscriptionMessagesrequired — (map)

                    The configuration for the transcription messages artifacts concatenation.

                    • Staterequired — (String)

                      Enables or disables the configuration object.

                      Possible values include:
                      • "Enabled"
                      • "Disabled"
                  • MeetingEventsrequired — (map)

                    The configuration for the meeting events artifacts concatenation.

                    • Staterequired — (String)

                      Enables or disables the configuration object.

                      Possible values include:
                      • "Enabled"
                      • "Disabled"
                  • CompositedVideorequired — (map)

                    The configuration for the composited video artifacts concatenation.

                    • Staterequired — (String)

                      Enables or disables the configuration object.

                      Possible values include:
                      • "Enabled"
                      • "Disabled"
          • Sinks — (Array<map>)

            The data sinks of the concatenation pipeline.

            • Typerequired — (String)

              The type of data sink in the configuration object.

              Possible values include:
              • "S3Bucket"
            • S3BucketSinkConfigurationrequired — (map)

              The configuration settings for an Amazon S3 bucket sink.

              • Destinationrequired — (String)

                The destination URL of the S3 bucket.

          • Status — (String)

            The status of the concatenation pipeline.

            Possible values include:
            • "Initializing"
            • "InProgress"
            • "Failed"
            • "Stopping"
            • "Stopped"
          • CreatedTimestamp — (Date)

            The time at which the concatenation pipeline was created.

          • UpdatedTimestamp — (Date)

            The time at which the concatenation pipeline was last updated.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listMediaCapturePipelines(params = {}, callback) ⇒ AWS.Request

Returns a list of media pipelines.

Service Reference:

Examples:

Calling the listMediaCapturePipelines operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkmediapipelines.listMediaCapturePipelines(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The token used to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call. Valid Range: 1 - 99.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MediaCapturePipelines — (Array<map>)

        The media pipeline objects in the list.

        • MediaPipelineId — (String)

          The ID of the media pipeline in the summary.

        • MediaPipelineArn — (String)

          The ARN of the media pipeline in the summary.

      • NextToken — (String)

        The token used to retrieve the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listMediaPipelines(params = {}, callback) ⇒ AWS.Request

Returns a list of media pipelines.

Service Reference:

Examples:

Calling the listMediaPipelines operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
chimesdkmediapipelines.listMediaPipelines(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      The token used to retrieve the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return in a single call. Valid Range: 1 - 99.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MediaPipelines — (Array<map>)

        The media pipeline objects in the list.

        • MediaPipelineId — (String)

          The ID of the media pipeline in the summary.

        • MediaPipelineArn — (String)

          The ARN of the media pipeline in the summary.

      • NextToken — (String)

        The token used to retrieve the next page of results.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags available for a media pipeline.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
chimesdkmediapipelines.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region, resource ID, and pipeline ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        The tags associated with the specified media pipeline.

        • Keyrequired — (String)

          The key half of a tag.

        • Valuerequired — (String)

          The value half of a tag.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
chimesdkmediapipelines.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID.

    • Tags — (Array<map>)

      The tags associated with the specified media pipeline.

      • Keyrequired — (String)

        The key half of a tag.

      • Valuerequired — (String)

        The value half of a tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes any tags from a media pipeline.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
chimesdkmediapipelines.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The ARN of the pipeline that you want to untag.

    • TagKeys — (Array<String>)

      The key/value pairs in the tag that you want to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.