Client

ivsrealtime

R Documentation

Amazon Interactive Video Service RealTime¶

Description¶

Introduction

The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.

Terminology:

A stage is a virtual space where participants can exchange video in real time.
A participant token is a token that authenticates a participant when they join a stage.
A participant object represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
Server-side composition: The composition process composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.
Server-side composition: A composition controls the look of the outputs, including how participants are positioned in the video.

Resources

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):

Stage — A stage is a virtual space where participants can exchange video in real time.

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS stages has no service-specific constraints beyond what is documented there.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS real-time API has these tag-related endpoints: tag_resource, untag_resource, and list_tags_for_resource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.

Stages Endpoints

create_participant_token — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
create_stage — Creates a new stage (and optionally participant tokens).
delete_stage — Shuts down and deletes the specified stage (disconnecting all participants).
disconnect_participant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
get_participant — Gets information about the specified participant token.
get_stage — Gets information for the specified stage.
get_stage_session — Gets information for the specified stage session.
list_participant_events — Lists events for a specified participant that occurred during a specified stage session.
list_participants — Lists all participants in a specified stage session.
list_stages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
list_stage_sessions — Gets all sessions for a specified stage.
update_stage — Updates a stage’s configuration.

Composition Endpoints

get_composition — Gets information about the specified Composition resource.
list_compositions — Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
start_composition — Starts a Composition from a stage based on the configuration provided in the request.
stop_composition — Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.

EncoderConfiguration Endpoints

create_encoder_configuration — Creates an EncoderConfiguration object.
delete_encoder_configuration — Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
get_encoder_configuration — Gets information about the specified EncoderConfiguration resource.
list_encoder_configurations — Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.

StorageConfiguration Endpoints

create_storage_configuration — Creates a new storage configuration, used to enable recording to Amazon S3.
delete_storage_configuration — Deletes the storage configuration for the specified ARN.
get_storage_configuration — Gets the storage configuration for the specified ARN.
list_storage_configurations — Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

Tags Endpoints

list_tags_for_resource — Gets information about AWS tags for the specified ARN.
tag_resource — Adds or updates tags for the AWS resource with the specified ARN.
untag_resource — Removes tags from the resource with the specified ARN.

Usage¶

ivsrealtime(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- ivsrealtime(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

create_encoder_configuration: Creates an EncoderConfiguration object
create_participant_token: Creates an additional token for a specified stage
create_stage: Creates a new stage (and optionally participant tokens)
create_storage_configuration: Creates a new storage configuration, used to enable recording to Amazon S3
delete_encoder_configuration: Deletes an EncoderConfiguration resource
delete_stage: Shuts down and deletes the specified stage (disconnecting all participants)
delete_storage_configuration: Deletes the storage configuration for the specified ARN
disconnect_participant: Disconnects a specified participant and revokes the participant permanently from a specified stage
get_composition: Get information about the specified Composition resource
get_encoder_configuration: Gets information about the specified EncoderConfiguration resource
get_participant: Gets information about the specified participant token
get_stage: Gets information for the specified stage
get_stage_session: Gets information for the specified stage session
get_storage_configuration: Gets the storage configuration for the specified ARN
list_compositions: Gets summary information about all Compositions in your account, in the AWS region where the API request is processed
list_encoder_configurations: Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed
list_participant_events: Lists events for a specified participant that occurred during a specified stage session
list_participants: Lists all participants in a specified stage session
list_stages: Gets summary information about all stages in your account, in the AWS region where the API request is processed
list_stage_sessions: Gets all sessions for a specified stage
list_storage_configurations: Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed
list_tags_for_resource: Gets information about AWS tags for the specified ARN
start_composition: Starts a Composition from a stage based on the configuration provided in the request
stop_composition: Stops and deletes a Composition resource
tag_resource: Adds or updates tags for the AWS resource with the specified ARN
untag_resource: Removes tags from the resource with the specified ARN
update_stage: Updates a stage’s configuration

Examples¶

## Not run: 
svc <- ivsrealtime()
svc$create_encoder_configuration(
  Foo = 123
)

## End(Not run)