Skip to content

/AWS1/IF_CHP=>CREATEMEDIACAPTUREPIPELINE()

About CreateMediaCapturePipeline

Creates a media pipeline.

Method Signature

METHODS /AWS1/IF_CHP~CREATEMEDIACAPTUREPIPELINE
  IMPORTING
    !IV_SOURCETYPE TYPE /AWS1/CHPMEDIAPLINSOURCETYPE OPTIONAL
    !IV_SOURCEARN TYPE /AWS1/CHPARN OPTIONAL
    !IV_SINKTYPE TYPE /AWS1/CHPMEDIAPIPELINESINKTYPE OPTIONAL
    !IV_SINKARN TYPE /AWS1/CHPARN OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/CHPCLIENTREQUESTTOKEN OPTIONAL
    !IO_CHIMESDKMEETINGCONF TYPE REF TO /AWS1/CL_CHPCHIMESDKMEETINGC00 OPTIONAL
    !IO_SSEAWSKEYMANAGEMENTPARAMS TYPE REF TO /AWS1/CL_CHPSSEAWSKEYMANAGEM00 OPTIONAL
    !IV_SINKIAMROLEARN TYPE /AWS1/CHPARN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CHPTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chpcremediacapturep01
  RAISING
    /AWS1/CX_CHPBADREQUESTEX
    /AWS1/CX_CHPFORBIDDENEXCEPTION
    /AWS1/CX_CHPRESRCLIMITEXCDEX
    /AWS1/CX_CHPSERVICEFAILUREEX
    /AWS1/CX_CHPSERVICEUNAVAILEX
    /AWS1/CX_CHPTHROTTLEDCLIENTEX
    /AWS1/CX_CHPUNAUTHDCLIENTEX
    /AWS1/CX_CHPCLIENTEXC
    /AWS1/CX_CHPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_sourcetype TYPE /AWS1/CHPMEDIAPLINSOURCETYPE /AWS1/CHPMEDIAPLINSOURCETYPE

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

iv_sourcearn TYPE /AWS1/CHPARN /AWS1/CHPARN

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

iv_sinktype TYPE /AWS1/CHPMEDIAPIPELINESINKTYPE /AWS1/CHPMEDIAPIPELINESINKTYPE

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

iv_sinkarn TYPE /AWS1/CHPARN /AWS1/CHPARN

The ARN of the sink type.

Optional arguments:

iv_clientrequesttoken TYPE /AWS1/CHPCLIENTREQUESTTOKEN /AWS1/CHPCLIENTREQUESTTOKEN

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

io_chimesdkmeetingconf TYPE REF TO /AWS1/CL_CHPCHIMESDKMEETINGC00 /AWS1/CL_CHPCHIMESDKMEETINGC00

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

io_sseawskeymanagementparams TYPE REF TO /AWS1/CL_CHPSSEAWSKEYMANAGEM00 /AWS1/CL_CHPSSEAWSKEYMANAGEM00

An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.

iv_sinkiamrolearn TYPE /AWS1/CHPARN /AWS1/CHPARN

The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams. Can only interact with S3Bucket sink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same for SinkIamRoleArn.

Additionally, the role must have permission to kms:GenerateDataKey using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission to kms:Decrypt for the same KMS key.

it_tags TYPE /AWS1/CL_CHPTAG=>TT_TAGLIST TT_TAGLIST

The tag key-value pairs.

RETURNING

oo_output TYPE REF TO /aws1/cl_chpcremediacapturep01 /AWS1/CL_CHPCREMEDIACAPTUREP01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createmediacapturepipeline(
  io_chimesdkmeetingconf = new /aws1/cl_chpchimesdkmeetingc00(
    io_artifactsconfiguration = new /aws1/cl_chpartifactsconf(
      io_audio = new /aws1/cl_chpaudioartifactsconf( |string| )
      io_compositedvideo = new /aws1/cl_chpcompositedvideoa00(
        io_gridviewconfiguration = new /aws1/cl_chpgridviewconf(
          io_activespeakeronlyconf = new /aws1/cl_chpactspeakeronlyconf( |string| )
          io_horizontallayoutconf = new /aws1/cl_chphorizontallayout00(
            iv_tileaspectratio = |string|
            iv_tilecount = 123
            iv_tileorder = |string|
            iv_tileposition = |string|
          )
          io_presenteronlyconf = new /aws1/cl_chppresenteronlyconf( |string| )
          io_verticallayoutconf = new /aws1/cl_chpverticallayoutconf(
            iv_tileaspectratio = |string|
            iv_tilecount = 123
            iv_tileorder = |string|
            iv_tileposition = |string|
          )
          io_videoattribute = new /aws1/cl_chpvideoattribute(
            iv_bordercolor = |string|
            iv_borderthickness = 123
            iv_cornerradius = 123
            iv_highlightcolor = |string|
          )
          iv_canvasorientation = |string|
          iv_contentsharelayout = |string|
        )
        iv_layout = |string|
        iv_resolution = |string|
      )
      io_content = new /aws1/cl_chpcontartifactsconf(
        iv_muxtype = |string|
        iv_state = |string|
      )
      io_video = new /aws1/cl_chpvideoartifactsconf(
        iv_muxtype = |string|
        iv_state = |string|
      )
    )
    io_sourceconfiguration = new /aws1/cl_chpsourceconf(
      io_selectedvideostreams = new /aws1/cl_chpseledvideostreams(
        it_attendeeids = VALUE /aws1/cl_chpattendeeidlist_w=>tt_attendeeidlist(
          ( new /aws1/cl_chpattendeeidlist_w( |string| ) )
        )
        it_externaluserids = VALUE /aws1/cl_chpexternaluseridls00=>tt_externaluseridlist(
          ( new /aws1/cl_chpexternaluseridls00( |string| ) )
        )
      )
    )
  )
  io_sseawskeymanagementparams = new /aws1/cl_chpsseawskeymanagem00(
    iv_awskmsencryptioncontext = |string|
    iv_awskmskeyid = |string|
  )
  it_tags = VALUE /aws1/cl_chptag=>tt_taglist(
    (
      new /aws1/cl_chptag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clientrequesttoken = |string|
  iv_sinkarn = |string|
  iv_sinkiamrolearn = |string|
  iv_sinktype = |string|
  iv_sourcearn = |string|
  iv_sourcetype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_mediacapturepipeline = lo_result->get_mediacapturepipeline( ).
  IF lo_mediacapturepipeline IS NOT INITIAL.
    lv_guidstring = lo_mediacapturepipeline->get_mediapipelineid( ).
    lv_amazonresourcename = lo_mediacapturepipeline->get_mediapipelinearn( ).
    lv_mediapipelinesourcetype = lo_mediacapturepipeline->get_sourcetype( ).
    lv_arn = lo_mediacapturepipeline->get_sourcearn( ).
    lv_mediapipelinestatus = lo_mediacapturepipeline->get_status( ).
    lv_mediapipelinesinktype = lo_mediacapturepipeline->get_sinktype( ).
    lv_arn = lo_mediacapturepipeline->get_sinkarn( ).
    lv_iso8601timestamp = lo_mediacapturepipeline->get_createdtimestamp( ).
    lv_iso8601timestamp = lo_mediacapturepipeline->get_updatedtimestamp( ).
    lo_chimesdkmeetingconfigur = lo_mediacapturepipeline->get_chimesdkmeetingconf( ).
    IF lo_chimesdkmeetingconfigur IS NOT INITIAL.
      lo_sourceconfiguration = lo_chimesdkmeetingconfigur->get_sourceconfiguration( ).
      IF lo_sourceconfiguration IS NOT INITIAL.
        lo_selectedvideostreams = lo_sourceconfiguration->get_selectedvideostreams( ).
        IF lo_selectedvideostreams IS NOT INITIAL.
          LOOP AT lo_selectedvideostreams->get_attendeeids( ) into lo_row.
            lo_row_1 = lo_row.
            IF lo_row_1 IS NOT INITIAL.
              lv_guidstring = lo_row_1->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_selectedvideostreams->get_externaluserids( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_externaluseridtype = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
      lo_artifactsconfiguration = lo_chimesdkmeetingconfigur->get_artifactsconfiguration( ).
      IF lo_artifactsconfiguration IS NOT INITIAL.
        lo_audioartifactsconfigura = lo_artifactsconfiguration->get_audio( ).
        IF lo_audioartifactsconfigura IS NOT INITIAL.
          lv_audiomuxtype = lo_audioartifactsconfigura->get_muxtype( ).
        ENDIF.
        lo_videoartifactsconfigura = lo_artifactsconfiguration->get_video( ).
        IF lo_videoartifactsconfigura IS NOT INITIAL.
          lv_artifactsstate = lo_videoartifactsconfigura->get_state( ).
          lv_videomuxtype = lo_videoartifactsconfigura->get_muxtype( ).
        ENDIF.
        lo_contentartifactsconfigu = lo_artifactsconfiguration->get_content( ).
        IF lo_contentartifactsconfigu IS NOT INITIAL.
          lv_artifactsstate = lo_contentartifactsconfigu->get_state( ).
          lv_contentmuxtype = lo_contentartifactsconfigu->get_muxtype( ).
        ENDIF.
        lo_compositedvideoartifact = lo_artifactsconfiguration->get_compositedvideo( ).
        IF lo_compositedvideoartifact IS NOT INITIAL.
          lv_layoutoption = lo_compositedvideoartifact->get_layout( ).
          lv_resolutionoption = lo_compositedvideoartifact->get_resolution( ).
          lo_gridviewconfiguration = lo_compositedvideoartifact->get_gridviewconfiguration( ).
          IF lo_gridviewconfiguration IS NOT INITIAL.
            lv_contentsharelayoutoptio = lo_gridviewconfiguration->get_contentsharelayout( ).
            lo_presenteronlyconfigurat = lo_gridviewconfiguration->get_presenteronlyconf( ).
            IF lo_presenteronlyconfigurat IS NOT INITIAL.
              lv_presenterposition = lo_presenteronlyconfigurat->get_presenterposition( ).
            ENDIF.
            lo_activespeakeronlyconfig = lo_gridviewconfiguration->get_activespeakeronlyconf( ).
            IF lo_activespeakeronlyconfig IS NOT INITIAL.
              lv_activespeakerposition = lo_activespeakeronlyconfig->get_activespeakerposition( ).
            ENDIF.
            lo_horizontallayoutconfigu = lo_gridviewconfiguration->get_horizontallayoutconf( ).
            IF lo_horizontallayoutconfigu IS NOT INITIAL.
              lv_tileorder = lo_horizontallayoutconfigu->get_tileorder( ).
              lv_horizontaltileposition = lo_horizontallayoutconfigu->get_tileposition( ).
              lv_tilecount = lo_horizontallayoutconfigu->get_tilecount( ).
              lv_tileaspectratio = lo_horizontallayoutconfigu->get_tileaspectratio( ).
            ENDIF.
            lo_verticallayoutconfigura = lo_gridviewconfiguration->get_verticallayoutconf( ).
            IF lo_verticallayoutconfigura IS NOT INITIAL.
              lv_tileorder = lo_verticallayoutconfigura->get_tileorder( ).
              lv_verticaltileposition = lo_verticallayoutconfigura->get_tileposition( ).
              lv_tilecount = lo_verticallayoutconfigura->get_tilecount( ).
              lv_tileaspectratio = lo_verticallayoutconfigura->get_tileaspectratio( ).
            ENDIF.
            lo_videoattribute = lo_gridviewconfiguration->get_videoattribute( ).
            IF lo_videoattribute IS NOT INITIAL.
              lv_cornerradius = lo_videoattribute->get_cornerradius( ).
              lv_bordercolor = lo_videoattribute->get_bordercolor( ).
              lv_highlightcolor = lo_videoattribute->get_highlightcolor( ).
              lv_borderthickness = lo_videoattribute->get_borderthickness( ).
            ENDIF.
            lv_canvasorientation = lo_gridviewconfiguration->get_canvasorientation( ).
          ENDIF.
        ENDIF.
      ENDIF.
    ENDIF.
    lo_sseawskeymanagementpara = lo_mediacapturepipeline->get_sseawskeymanagementparms( ).
    IF lo_sseawskeymanagementpara IS NOT INITIAL.
      lv_string = lo_sseawskeymanagementpara->get_awskmskeyid( ).
      lv_string = lo_sseawskeymanagementpara->get_awskmsencryptioncontext( ).
    ENDIF.
    lv_arn = lo_mediacapturepipeline->get_sinkiamrolearn( ).
  ENDIF.
ENDIF.