Skip to content

API for Amazon Interactive Video Service RealTime

ABAP Package /AWS1/API_IVR_IMPL
ABAP SDK "TLA" IVR
ABAP Interface /AWS1/IF_IVR

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Amazon Interactive Video Service RealTime is IVR. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the IVS RealTime module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service

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.

Key Concepts

  • Stage — A virtual space where participants can exchange video in real time.

  • Participant token — A token that authenticates a participant when they join a stage.

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

For server-side composition:

  • Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition operations support this process.

  • Composition — Controls the look of the outputs, including how participants are positioned in the video.

For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.

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 Best practices and strategies in Tagging AWS Resources and Tag Editor for details, 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 operations: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.

At most 50 tags can be applied to a resource.

Using the SDK

In your code, create a client using the SDK module for Amazon Interactive Video Service RealTime, which is created with factory method /AWS1/CL_IVR_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_ivr)       = /aws1/cl_ivr_factory=>create( go_session ).

Your variable go_ivr is an instance of /AWS1/IF_IVR, and all of the operations in the Amazon Interactive Video Service RealTime service are accessed by calling methods in /AWS1/IF_IVR.

API Operations

For an overview of ABAP method calls corresponding to API operations in Amazon Interactive Video Service RealTime, see the Operation List.

Factory Method

/AWS1/CL_IVR_FACTORY=>create( )

Creates an object of type /AWS1/IF_IVR.

IMPORTING

Optional arguments:

iv_protocol TYPE /aws1/rt_protocol /AWS1/RT_PROTOCOL

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

io_session TYPE REF TO /aws1/cl_rt_session_base /AWS1/CL_RT_SESSION_BASE

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

iv_region TYPE /aws1/rt_region_id /AWS1/RT_REGION_ID

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

iv_custom_endpoint TYPE /aws1/rt_endpoint /AWS1/RT_ENDPOINT

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

RETURNING

oo_client TYPE REF TO /aws1/if_ivr /AWS1/IF_IVR

/AWS1/IF_IVR represents the ABAP client for the IVS RealTime service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically

DATA(lo_config) = DATA(go_ivr)->get_config( ).

lo_config is a variable of type /AWS1/CL_IVR_CONFIG. See the documentation for /AWS1/CL_IVR_CONFIG for details on the settings that can be configured.

Paginators

Paginators for Amazon Interactive Video Service RealTime can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_IVR_PAGINATOR`](./_AWS1_IF_IVR_PAGINATOR.md). The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using `has_next()` and `get_next()` methods.

Details about the paginator methods available for service Amazon Interactive Video Service RealTime can be found in interface [`/AWS1/IF_IVR_PAGINATOR`](./_AWS1_IF_IVR_PAGINATOR.md).