Class: AWS.IVSRealTime

var params = {
  stageArn: 'STRING_VALUE', /* required */
  attributes: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  capabilities: [
    PUBLISH | SUBSCRIBE,
    /* more items */
  ],
  duration: 'NUMBER_VALUE',
  userId: 'STRING_VALUE'
};
ivsrealtime.createParticipantToken(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: {}) —
  • attributes — (map<String>)

    Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

  • capabilities — (Array<String>)

    Set of capabilities that the user is allowed to perform in the stage. Default: PUBLISH, SUBSCRIBE.

  • duration — (Integer)

    Duration (in minutes), after which the token expires. Default: 720 (12 hours).

  • stageArn — (String)

    ARN of the stage to which this token is scoped.

  • userId — (String)

    Name that can be specified to help identify the token. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

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:

    • participantToken — (map)

      The participant token that was created.

      • attributes — (map<String>)

        Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      • capabilities — (Array<String>)

        Set of capabilities that the user is allowed to perform in the stage.

      • duration — (Integer)

        Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).

      • expirationTime — (Date)

        ISO 8601 timestamp (returned as a string) for when this token expires.

      • participantId — (String)

        Unique identifier for this participant token, assigned by IVS.

      • token — (String)

        The issued client token, encrypted.

      • userId — (String)

        Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE',
  participantTokenConfigurations: [
    {
      attributes: {
        '<String>': 'STRING_VALUE',
        /* '<String>': ... */
      },
      capabilities: [
        PUBLISH | SUBSCRIBE,
        /* more items */
      ],
      duration: 'NUMBER_VALUE',
      userId: 'STRING_VALUE'
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivsrealtime.createStage(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: {}) —
  • name — (String)

    Optional name that can be specified for the stage being created.

  • participantTokenConfigurations — (Array<map>)

    Array of participant token configuration objects to attach to the new stage.

    • attributes — (map<String>)

      Application-provided attributes to encode into the corresponding participant token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

    • capabilities — (Array<String>)

      Set of capabilities that the user is allowed to perform in the stage.

    • duration — (Integer)

      Duration (in minutes), after which the corresponding participant token expires. Default: 720 (12 hours).

    • userId — (String)

      Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

  • tags — (map<String>)

    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

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:

    • participantTokens — (Array<map>)

      Participant tokens attached to the stage. These correspond to the participants in the request.

      • attributes — (map<String>)

        Application-provided attributes to encode into the token and attach to a stage. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      • capabilities — (Array<String>)

        Set of capabilities that the user is allowed to perform in the stage.

      • duration — (Integer)

        Duration (in minutes), after which the participant token expires. Default: 720 (12 hours).

      • expirationTime — (Date)

        ISO 8601 timestamp (returned as a string) for when this token expires.

      • participantId — (String)

        Unique identifier for this participant token, assigned by IVS.

      • token — (String)

        The issued client token, encrypted.

      • userId — (String)

        Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

    • stage — (map)

      The stage that was created.

      • activeSessionId — (String)

        ID of the active session within the stage.

      • arn — required — (String)

        Stage ARN.

      • name — (String)

        Stage name.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

• (AWS.Request) —

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

var params = {
  s3: { /* required */
    bucketName: 'STRING_VALUE' /* required */
  },
  name: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivsrealtime.createStorageConfiguration(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: {}) —
  • name — (String)

    Storage configuration name. The value does not need to be unique.

  • s3 — (map)

    A complex type that contains a storage configuration for where recorded video will be stored.

    • bucketName — required — (String)

      Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.

  • tags — (map<String>)

    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

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:

    • storageConfiguration — (map)

      The StorageConfiguration that was created.

      • arn — required — (String)

        ARN of the storage configuration.

      • name — (String)

        Name of the storage configuration.

      • s3 — (map)

        An S3 destination configuration where recorded videos will be stored.

        • bucketName — required — (String)

          Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

• (AWS.Request) —

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

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.deleteEncoderConfiguration(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: {}) —
  • arn — (String)

    ARN of the EncoderConfiguration.

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.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.deleteStage(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: {}) —
  • arn — (String)

    ARN of the stage to be 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.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.deleteStorageConfiguration(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: {}) —
  • arn — (String)

    ARN of the storage configuration to be 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.

var params = {
  participantId: 'STRING_VALUE', /* required */
  stageArn: 'STRING_VALUE', /* required */
  reason: 'STRING_VALUE'
};
ivsrealtime.disconnectParticipant(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: {}) —
  • participantId — (String)

    Identifier of the participant to be disconnected. This is assigned by IVS and returned by CreateParticipantToken.

  • reason — (String)

    Description of why this participant is being disconnected.

  • stageArn — (String)

    ARN of the stage to which the participant is attached.

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.

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.getComposition(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: {}) —
  • arn — (String)

    ARN of the Composition resource.

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:

    • composition — (map)

      The Composition that was returned.

      • arn — required — (String)

        ARN of the Composition resource.

      • destinations — required — (Array<map>)

        Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).

        • configuration — required — (map)

          Configuration used to create this destination.

          • channel — (map)

            An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.

            • channelArn — required — (String)

              ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).

            • encoderConfigurationArn — (String)

              ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

          • name — (String)

            Name that can be specified to help identify the destination.

          • s3 — (map)

            An S3 storage configuration to be used for recording video data. Either a channel or an s3 must be specified.

            • encoderConfigurationArns — required — (Array<String>)

              ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

            • recordingConfiguration — (map)

              Array of maps, each of the form string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.

              • format — (String)

                The recording format for storing a recording in Amazon S3.

                Possible values include:
                • "HLS"
            • storageConfigurationArn — required — (String)

              ARN of the StorageConfiguration where recorded videos will be stored.

        • detail — (map)

          Optional details regarding the status of the destination.

          • s3 — (map)

            An S3 detail object to return information about the S3 destination.

            • recordingPrefix — required — (String)

              The S3 bucket prefix under which the recording is stored.

        • endTime — (Date)

          UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.

        • id — required — (String)

          Unique identifier for this destination, assigned by IVS.

        • startTime — (Date)

          UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.

        • state — required — (String)

          State of the Composition Destination.

          Possible values include:
          • "STARTING"
          • "ACTIVE"
          • "STOPPING"
          • "RECONNECTING"
          • "FAILED"
          • "STOPPED"
      • endTime — (Date)

        UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

      • layout — required — (map)

        Layout object to configure composition parameters.

        • grid — (map)

          Configuration related to grid layout. Default: Grid layout.

          • featuredParticipantAttribute — (String)

            This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.

          • gridGap — (Integer)

            Specifies the spacing between participant tiles in pixels. Default: 2.

          • omitStoppedVideo — (Boolean)

            Determines whether to omit participants with stopped video in the composition. Default: false.

          • videoAspectRatio — (String)

            Sets the non-featured participant display mode. Default: VIDEO.

            Possible values include:
            • "AUTO"
            • "VIDEO"
            • "SQUARE"
            • "PORTRAIT"
          • videoFillMode — (String)

            Defines how video fits within the participant tile. When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.

            Possible values include:
            • "FILL"
            • "COVER"
            • "CONTAIN"
        • pip — (map)

          Configuration related to PiP layout.

          • featuredParticipantAttribute — (String)

            This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.

          • gridGap — (Integer)

            Specifies the spacing between participant tiles in pixels. Default: 0.

          • omitStoppedVideo — (Boolean)

            Determines whether to omit participants with stopped video in the composition. Default: false.

          • pipBehavior — (String)

            Defines PiP behavior when all participants have left. Default: STATIC.

            Possible values include:
            • "STATIC"
            • "DYNAMIC"
          • pipHeight — (Integer)

            Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

          • pipOffset — (Integer)

            Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

          • pipParticipantAttribute — (String)

            Identifies the PiP slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot.

          • pipPosition — (String)

            Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

            Possible values include:
            • "TOP_LEFT"
            • "TOP_RIGHT"
            • "BOTTOM_LEFT"
            • "BOTTOM_RIGHT"
          • pipWidth — (Integer)

            Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

          • videoFillMode — (String)

            Defines how video fits within the participant tile. Default: COVER.

            Possible values include:
            • "FILL"
            • "COVER"
            • "CONTAIN"
      • stageArn — required — (String)

        ARN of the stage used as input

      • startTime — (Date)

        UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

      • state — required — (String)

        State of the Composition.

        Possible values include:
        • "STARTING"
        • "ACTIVE"
        • "STOPPING"
        • "FAILED"
        • "STOPPED"
      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

• (AWS.Request) —

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

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.getEncoderConfiguration(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: {}) —
  • arn — (String)

    ARN of the EncoderConfiguration resource.

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:

    • encoderConfiguration — (map)

      The EncoderConfiguration that was returned.

      • arn — required — (String)

        ARN of the EncoderConfiguration resource.

      • name — (String)

        Optional name to identify the resource.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

      • video — (map)

        Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30 fps

        • bitrate — (Integer)

          Bitrate for generated output, in bps. Default: 2500000.

        • framerate — (Float)

          Video frame rate, in fps. Default: 30.

        • height — (Integer)

          Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.

        • width — (Integer)

          Video-resolution width. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.

Returns:

• (AWS.Request) —

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

var params = {
  participantId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE', /* required */
  stageArn: 'STRING_VALUE' /* required */
};
ivsrealtime.getParticipant(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: {}) —
  • participantId — (String)

    Unique identifier for the participant. This is assigned by IVS and returned by CreateParticipantToken.

  • sessionId — (String)

    ID of a session within the stage.

  • stageArn — (String)

    Stage ARN.

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:

    • participant — (map)

      The participant that is returned.

      • attributes — (map<String>)

        Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      • browserName — (String)

        The participant’s browser.

      • browserVersion — (String)

        The participant’s browser version.

      • firstJoinTime — (Date)

        ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

      • ispName — (String)

        The participant’s Internet Service Provider.

      • osName — (String)

        The participant’s operating system.

      • osVersion — (String)

        The participant’s operating system version.

      • participantId — (String)

        Unique identifier for this participant, assigned by IVS.

      • published — (Boolean)

        Whether the participant ever published to the stage session.

      • sdkVersion — (String)

        The participant’s SDK version.

      • state — (String)

        Whether the participant is connected to or disconnected from the stage.

        Possible values include:
        • "CONNECTED"
        • "DISCONNECTED"
      • userId — (String)

        Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Returns:

• (AWS.Request) —

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

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.getStage(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: {}) —
  • arn — (String)

    ARN of the stage for which the information is to be retrieved.

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:

    • stage — (map)

      The stage that is returned.

      • activeSessionId — (String)

        ID of the active session within the stage.

      • arn — required — (String)

        Stage ARN.

      • name — (String)

        Stage name.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

• (AWS.Request) —

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

var params = {
  sessionId: 'STRING_VALUE', /* required */
  stageArn: 'STRING_VALUE' /* required */
};
ivsrealtime.getStageSession(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: {}) —
  • sessionId — (String)

    ID of a session within the stage.

  • stageArn — (String)

    ARN of the stage for which the information is to be retrieved.

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:

    • stageSession — (map)

      The stage session that is returned.

      • endTime — (Date)

        ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.

      • sessionId — (String)

        ID of the session within the stage.

      • startTime — (Date)

        ISO 8601 timestamp (returned as a string) when this stage session began.

Returns:

• (AWS.Request) —

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

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.getStorageConfiguration(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: {}) —
  • arn — (String)

    ARN of the storage configuration to be retrieved.

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:

    • storageConfiguration — (map)

      The StorageConfiguration that was returned.

      • arn — required — (String)

        ARN of the storage configuration.

      • name — (String)

        Name of the storage configuration.

      • s3 — (map)

        An S3 destination configuration where recorded videos will be stored.

        • bucketName — required — (String)

          Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

• (AWS.Request) —

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

var params = {
  filterByEncoderConfigurationArn: 'STRING_VALUE',
  filterByStageArn: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listCompositions(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: {}) —
  • filterByEncoderConfigurationArn — (String)

    Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.

  • filterByStageArn — (String)

    Filters the Composition list to match the specified Stage ARN.

  • maxResults — (Integer)

    Maximum number of results to return. Default: 100.

  • nextToken — (String)

    The first Composition to retrieve. This is used for pagination; see the nextToken response field.

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:

    • compositions — (Array<map>)

      List of the matching Compositions (summary information only).

      • arn — required — (String)

        ARN of the Composition resource.

      • destinations — required — (Array<map>)

        Array of Destination objects.

        • endTime — (Date)

          UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.

        • id — required — (String)

          Unique identifier for this destination, assigned by IVS.

        • startTime — (Date)

          UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.

        • state — required — (String)

          State of the Composition Destination.

          Possible values include:
          • "STARTING"
          • "ACTIVE"
          • "STOPPING"
          • "RECONNECTING"
          • "FAILED"
          • "STOPPED"
      • endTime — (Date)

        UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

      • stageArn — required — (String)

        ARN of the attached stage.

      • startTime — (Date)

        UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

      • state — required — (String)

        State of the Composition resource.

        Possible values include:
        • "STARTING"
        • "ACTIVE"
        • "STOPPING"
        • "FAILED"
        • "STOPPED"
      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

    • nextToken — (String)

      If there are more compositions than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listEncoderConfigurations(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: {}) —
  • maxResults — (Integer)

    Maximum number of results to return. Default: 100.

  • nextToken — (String)

    The first encoder configuration to retrieve. This is used for pagination; see the nextToken response field.

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:

    • encoderConfigurations — (Array<map>)

      List of the matching EncoderConfigurations (summary information only).

      • arn — required — (String)

        ARN of the EncoderConfiguration resource.

      • name — (String)

        Optional name to identify the resource.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

    • nextToken — (String)

      If there are more encoder configurations than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

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

var params = {
  participantId: 'STRING_VALUE', /* required */
  sessionId: 'STRING_VALUE', /* required */
  stageArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listParticipantEvents(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: {}) —
  • maxResults — (Integer)

    Maximum number of results to return. Default: 50.

  • nextToken — (String)

    The first participant event to retrieve. This is used for pagination; see the nextToken response field.

  • participantId — (String)

    Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.

  • sessionId — (String)

    ID of a session within the stage.

  • stageArn — (String)

    Stage ARN.

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:

    • events — (Array<map>)

      List of the matching events.

      • errorCode — (String)

        If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.

        Possible values include:
        • "INSUFFICIENT_CAPABILITIES"
        • "QUOTA_EXCEEDED"
        • "PUBLISHER_NOT_FOUND"
      • eventTime — (Date)

        ISO 8601 timestamp (returned as a string) for when the event occurred.

      • name — (String)

        The name of the event.

        Possible values include:
        • "JOINED"
        • "LEFT"
        • "PUBLISH_STARTED"
        • "PUBLISH_STOPPED"
        • "SUBSCRIBE_STARTED"
        • "SUBSCRIBE_STOPPED"
        • "PUBLISH_ERROR"
        • "SUBSCRIBE_ERROR"
        • "JOIN_ERROR"
      • participantId — (String)

        Unique identifier for the participant who triggered the event. This is assigned by IVS.

      • remoteParticipantId — (String)

        Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.

    • nextToken — (String)

      If there are more events than maxResults, use nextToken in the request to get the next set.

Returns:

• (AWS.Request) —

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

var params = {
  sessionId: 'STRING_VALUE', /* required */
  stageArn: 'STRING_VALUE', /* required */
  filterByPublished: true || false,
  filterByState: CONNECTED | DISCONNECTED,
  filterByUserId: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listParticipants(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: {}) —
  • filterByPublished — (Boolean)

    Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request.

  • filterByState — (String)

    Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request.

    Possible values include:
    • "CONNECTED"
    • "DISCONNECTED"
  • filterByUserId — (String)

    Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

  • maxResults — (Integer)

    Maximum number of results to return. Default: 50.

  • nextToken — (String)

    The first participant to retrieve. This is used for pagination; see the nextToken response field.

  • sessionId — (String)

    ID of the session within the stage.

  • stageArn — (String)

    Stage ARN.

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:

    • nextToken — (String)

      If there are more participants than maxResults, use nextToken in the request to get the next set.

    • participants — (Array<map>)

      List of the matching participants (summary information only).

      • firstJoinTime — (Date)

        ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

      • participantId — (String)

        Unique identifier for this participant, assigned by IVS.

      • published — (Boolean)

        Whether the participant ever published to the stage session.

      • state — (String)

        Whether the participant is connected to or disconnected from the stage.

        Possible values include:
        • "CONNECTED"
        • "DISCONNECTED"
      • userId — (String)

        Customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listStages(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: {}) —
  • maxResults — (Integer)

    Maximum number of results to return. Default: 50.

  • nextToken — (String)

    The first stage to retrieve. This is used for pagination; see the nextToken response field.

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:

    • nextToken — (String)

      If there are more stages than maxResults, use nextToken in the request to get the next set.

    • stages — (Array<map>)

      List of the matching stages (summary information only).

      • activeSessionId — (String)

        ID of the active session within the stage.

      • arn — required — (String)

        Stage ARN.

      • name — (String)

        Stage name.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

• (AWS.Request) —

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

var params = {
  stageArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listStageSessions(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: {}) —
  • maxResults — (Integer)

    Maximum number of results to return. Default: 50.

  • nextToken — (String)

    The first stage session to retrieve. This is used for pagination; see the nextToken response field.

  • stageArn — (String)

    Stage ARN.

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:

    • nextToken — (String)

      If there are more stage sessions than maxResults, use nextToken in the request to get the next set.

    • stageSessions — (Array<map>)

      List of matching stage sessions.

      • endTime — (Date)

        ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.

      • sessionId — (String)

        ID of the session within the stage.

      • startTime — (Date)

        ISO 8601 timestamp (returned as a string) when this stage session began.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ivsrealtime.listStorageConfigurations(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: {}) —
  • maxResults — (Integer)

    Maximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.

  • nextToken — (String)

    The first storage configuration to retrieve. This is used for pagination; see the nextToken response field.

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:

    • nextToken — (String)

      If there are more storage configurations than maxResults, use nextToken in the request to get the next set.

    • storageConfigurations — (Array<map>)

      List of the matching storage configurations.

      • arn — required — (String)

        ARN of the storage configuration.

      • name — (String)

        Name of the storage configuration.

      • s3 — (map)

        An S3 destination configuration where recorded videos will be stored.

        • bucketName — required — (String)

          Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
ivsrealtime.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 resource to be retrieved. The ARN must be URL-encoded.

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 — (map<String>)

      Tags attached to the resource. Array of maps, each of the form string:string (key:value).

Returns:

• (AWS.Request) —

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

var params = {
  destinations: [ /* required */
    {
      channel: {
        channelArn: 'STRING_VALUE', /* required */
        encoderConfigurationArn: 'STRING_VALUE'
      },
      name: 'STRING_VALUE',
      s3: {
        encoderConfigurationArns: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        storageConfigurationArn: 'STRING_VALUE', /* required */
        recordingConfiguration: {
          format: HLS
        }
      }
    },
    /* more items */
  ],
  stageArn: 'STRING_VALUE', /* required */
  idempotencyToken: 'STRING_VALUE',
  layout: {
    grid: {
      featuredParticipantAttribute: 'STRING_VALUE',
      gridGap: 'NUMBER_VALUE',
      omitStoppedVideo: true || false,
      videoAspectRatio: AUTO | VIDEO | SQUARE | PORTRAIT,
      videoFillMode: FILL | COVER | CONTAIN
    },
    pip: {
      featuredParticipantAttribute: 'STRING_VALUE',
      gridGap: 'NUMBER_VALUE',
      omitStoppedVideo: true || false,
      pipBehavior: STATIC | DYNAMIC,
      pipHeight: 'NUMBER_VALUE',
      pipOffset: 'NUMBER_VALUE',
      pipParticipantAttribute: 'STRING_VALUE',
      pipPosition: TOP_LEFT | TOP_RIGHT | BOTTOM_LEFT | BOTTOM_RIGHT,
      pipWidth: 'NUMBER_VALUE',
      videoFillMode: FILL | COVER | CONTAIN
    }
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivsrealtime.startComposition(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: {}) —
  • destinations — (Array<map>)

    Array of destination configuration.

    • channel — (map)

      An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.

      • channelArn — required — (String)

        ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).

      • encoderConfigurationArn — (String)

        ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

    • name — (String)

      Name that can be specified to help identify the destination.

    • s3 — (map)

      An S3 storage configuration to be used for recording video data. Either a channel or an s3 must be specified.

      • encoderConfigurationArns — required — (Array<String>)

        ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

      • recordingConfiguration — (map)

        Array of maps, each of the form string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.

        • format — (String)

          The recording format for storing a recording in Amazon S3.

          Possible values include:
          • "HLS"
      • storageConfigurationArn — required — (String)

        ARN of the StorageConfiguration where recorded videos will be stored.

  • idempotencyToken — (String)

    Idempotency token.

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

    Layout object to configure composition parameters.

    • grid — (map)

      Configuration related to grid layout. Default: Grid layout.

      • featuredParticipantAttribute — (String)

        This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.

      • gridGap — (Integer)

        Specifies the spacing between participant tiles in pixels. Default: 2.

      • omitStoppedVideo — (Boolean)

        Determines whether to omit participants with stopped video in the composition. Default: false.

      • videoAspectRatio — (String)

        Sets the non-featured participant display mode. Default: VIDEO.

        Possible values include:
        • "AUTO"
        • "VIDEO"
        • "SQUARE"
        • "PORTRAIT"
      • videoFillMode — (String)

        Defines how video fits within the participant tile. When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.

        Possible values include:
        • "FILL"
        • "COVER"
        • "CONTAIN"
    • pip — (map)

      Configuration related to PiP layout.

      • featuredParticipantAttribute — (String)

        This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.

      • gridGap — (Integer)

        Specifies the spacing between participant tiles in pixels. Default: 0.

      • omitStoppedVideo — (Boolean)

        Determines whether to omit participants with stopped video in the composition. Default: false.

      • pipBehavior — (String)

        Defines PiP behavior when all participants have left. Default: STATIC.

        Possible values include:
        • "STATIC"
        • "DYNAMIC"
      • pipHeight — (Integer)

        Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

      • pipOffset — (Integer)

        Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

      • pipParticipantAttribute — (String)

        Identifies the PiP slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot.

      • pipPosition — (String)

        Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

        Possible values include:
        • "TOP_LEFT"
        • "TOP_RIGHT"
        • "BOTTOM_LEFT"
        • "BOTTOM_RIGHT"
      • pipWidth — (Integer)

        Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

      • videoFillMode — (String)

        Defines how video fits within the participant tile. Default: COVER.

        Possible values include:
        • "FILL"
        • "COVER"
        • "CONTAIN"
  • stageArn — (String)

    ARN of the stage to be used for compositing.

  • tags — (map<String>)

    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

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:

    • composition — (map)

      The Composition that was created.

      • arn — required — (String)

        ARN of the Composition resource.

      • destinations — required — (Array<map>)

        Array of Destination objects. A Composition can contain either one destination (channel or s3) or two (one channel and one s3).

        • configuration — required — (map)

          Configuration used to create this destination.

          • channel — (map)

            An IVS channel to be used for broadcasting, for server-side composition. Either a channel or an s3 must be specified.

            • channelArn — required — (String)

              ARN of the channel to use for broadcasting. The channel and stage resources must be in the same AWS account and region. The channel must be offline (not broadcasting).

            • encoderConfigurationArn — (String)

              ARN of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

          • name — (String)

            Name that can be specified to help identify the destination.

          • s3 — (map)

            An S3 storage configuration to be used for recording video data. Either a channel or an s3 must be specified.

            • encoderConfigurationArns — required — (Array<String>)

              ARNs of the EncoderConfiguration resource. The encoder configuration and stage resources must be in the same AWS account and region.

            • recordingConfiguration — (map)

              Array of maps, each of the form string:string (key:value). This is an optional customer specification, currently used only to specify the recording format for storing a recording in Amazon S3.

              • format — (String)

                The recording format for storing a recording in Amazon S3.

                Possible values include:
                • "HLS"
            • storageConfigurationArn — required — (String)

              ARN of the StorageConfiguration where recorded videos will be stored.

        • detail — (map)

          Optional details regarding the status of the destination.

          • s3 — (map)

            An S3 detail object to return information about the S3 destination.

            • recordingPrefix — required — (String)

              The S3 bucket prefix under which the recording is stored.

        • endTime — (Date)

          UTC time of the destination end. This is an ISO 8601 timestamp; note that this is returned as a string.

        • id — required — (String)

          Unique identifier for this destination, assigned by IVS.

        • startTime — (Date)

          UTC time of the destination start. This is an ISO 8601 timestamp; note that this is returned as a string.

        • state — required — (String)

          State of the Composition Destination.

          Possible values include:
          • "STARTING"
          • "ACTIVE"
          • "STOPPING"
          • "RECONNECTING"
          • "FAILED"
          • "STOPPED"
      • endTime — (Date)

        UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

      • layout — required — (map)

        Layout object to configure composition parameters.

        • grid — (map)

          Configuration related to grid layout. Default: Grid layout.

          • featuredParticipantAttribute — (String)

            This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.

          • gridGap — (Integer)

            Specifies the spacing between participant tiles in pixels. Default: 2.

          • omitStoppedVideo — (Boolean)

            Determines whether to omit participants with stopped video in the composition. Default: false.

          • videoAspectRatio — (String)

            Sets the non-featured participant display mode. Default: VIDEO.

            Possible values include:
            • "AUTO"
            • "VIDEO"
            • "SQUARE"
            • "PORTRAIT"
          • videoFillMode — (String)

            Defines how video fits within the participant tile. When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.

            Possible values include:
            • "FILL"
            • "COVER"
            • "CONTAIN"
        • pip — (map)

          Configuration related to PiP layout.

          • featuredParticipantAttribute — (String)

            This attribute name identifies the featured slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.

          • gridGap — (Integer)

            Specifies the spacing between participant tiles in pixels. Default: 0.

          • omitStoppedVideo — (Boolean)

            Determines whether to omit participants with stopped video in the composition. Default: false.

          • pipBehavior — (String)

            Defines PiP behavior when all participants have left. Default: STATIC.

            Possible values include:
            • "STATIC"
            • "DYNAMIC"
          • pipHeight — (Integer)

            Specifies the height of the PiP window in pixels. When this is not set explicitly, pipHeight’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

          • pipOffset — (Integer)

            Sets the PiP window’s offset position in pixels from the closest edges determined by PipPosition. Default: 0.

          • pipParticipantAttribute — (String)

            Identifies the PiP slot. A participant with this attribute set to "true" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot.

          • pipPosition — (String)

            Determines the corner position of the PiP window. Default: BOTTOM_RIGHT.

            Possible values include:
            • "TOP_LEFT"
            • "TOP_RIGHT"
            • "BOTTOM_LEFT"
            • "BOTTOM_RIGHT"
          • pipWidth — (Integer)

            Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.

          • videoFillMode — (String)

            Defines how video fits within the participant tile. Default: COVER.

            Possible values include:
            • "FILL"
            • "COVER"
            • "CONTAIN"
      • stageArn — required — (String)

        ARN of the stage used as input

      • startTime — (Date)

        UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

      • state — required — (String)

        State of the Composition.

        Possible values include:
        • "STARTING"
        • "ACTIVE"
        • "STOPPING"
        • "FAILED"
        • "STOPPED"
      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

• (AWS.Request) —

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

var params = {
  arn: 'STRING_VALUE' /* required */
};
ivsrealtime.stopComposition(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: {}) —
  • arn — (String)

    ARN of the Composition.

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.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ivsrealtime.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 resource to be tagged. The ARN must be URL-encoded.

  • tags — (map<String>)

    Array of tags to be added or updated. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints beyond what is documented there.

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.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ivsrealtime.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 resource to be untagged. The ARN must be URL-encoded.

  • tagKeys — (Array<String>)

    Array of tags to be removed. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints beyond what is documented there.

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.

var params = {
  arn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE'
};
ivsrealtime.updateStage(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: {}) —
  • arn — (String)

    ARN of the stage to be updated.

  • name — (String)

    Name of the stage to be updated.

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:

    • stage — (map)

      The updated stage.

      • activeSessionId — (String)

        ID of the active session within the stage.

      • arn — required — (String)

        Stage ARN.

      • name — (String)

        Stage name.

      • tags — (map<String>)

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

• (AWS.Request) —

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