/AWS1/IF_IVS=>UPDATECHANNEL()

About UpdateChannel

Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.

Method Signature

METHODS /AWS1/IF_IVS~UPDATECHANNEL
  IMPORTING
    !IV_ARN TYPE /AWS1/IVSCHANNELARN OPTIONAL
    !IV_NAME TYPE /AWS1/IVSCHANNELNAME OPTIONAL
    !IV_LATENCYMODE TYPE /AWS1/IVSCHANNELLATENCYMODE OPTIONAL
    !IV_TYPE TYPE /AWS1/IVSCHANNELTYPE OPTIONAL
    !IV_AUTHORIZED TYPE /AWS1/IVSBOOLEAN OPTIONAL
    !IV_RECORDINGCONFIGURATIONARN TYPE /AWS1/IVSCHANNELRECINGCONFARN OPTIONAL
    !IV_INSECUREINGEST TYPE /AWS1/IVSBOOLEAN OPTIONAL
    !IV_PRESET TYPE /AWS1/IVSTRANSCODEPRESET OPTIONAL
    !IV_PLAYBACKRESTRICTIONPLYARN TYPE /AWS1/IVSCHANNELPLAYBACKREST00 OPTIONAL
    !IO_MULTITRACKINPUTCONF TYPE REF TO /AWS1/CL_IVSMULTITRACKINPCONF OPTIONAL
    !IV_CONTAINERFORMAT TYPE /AWS1/IVSCONTAINERFORMAT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ivsupdatechannelrsp
  RAISING
    /AWS1/CX_IVSACCESSDENIEDEX
    /AWS1/CX_IVSCONFLICTEXCEPTION
    /AWS1/CX_IVSPENDINGVERIFICAT00
    /AWS1/CX_IVSRESOURCENOTFOUNDEX
    /AWS1/CX_IVSVALIDATIONEX
    /AWS1/CX_IVSCLIENTEXC
    /AWS1/CX_IVSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_arn TYPE /AWS1/IVSCHANNELARN /AWS1/IVSCHANNELARN

ARN of the channel to be updated.

Optional arguments:

iv_name TYPE /AWS1/IVSCHANNELNAME /AWS1/IVSCHANNELNAME

Channel name.

iv_latencymode TYPE /AWS1/IVSCHANNELLATENCYMODE /AWS1/IVSCHANNELLATENCYMODE

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers.

iv_type TYPE /AWS1/IVSCHANNELTYPE /AWS1/IVSCHANNELTYPE

Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

iv_authorized TYPE /AWS1/IVSBOOLEAN /AWS1/IVSBOOLEAN

Whether the channel is private (enabled for playback authorization).

iv_recordingconfigurationarn TYPE /AWS1/IVSCHANNELRECINGCONFARN /AWS1/IVSCHANNELRECINGCONFARN

Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.

iv_insecureingest TYPE /AWS1/IVSBOOLEAN /AWS1/IVSBOOLEAN

Whether the channel allows insecure RTMP and SRT ingest. Default: false.

iv_preset TYPE /AWS1/IVSTRANSCODEPRESET /AWS1/IVSTRANSCODEPRESET

Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

iv_playbackrestrictionplyarn TYPE /AWS1/IVSCHANNELPLAYBACKREST00 /AWS1/IVSCHANNELPLAYBACKREST00

Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.

io_multitrackinputconf TYPE REF TO /AWS1/CL_IVSMULTITRACKINPCONF /AWS1/CL_IVSMULTITRACKINPCONF

Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

iv_containerformat TYPE /AWS1/IVSCONTAINERFORMAT /AWS1/IVSCONTAINERFORMAT

Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.

RETURNING

oo_output TYPE REF TO /aws1/cl_ivsupdatechannelrsp /AWS1/CL_IVSUPDATECHANNELRSP

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->updatechannel(
  io_multitrackinputconf = new /aws1/cl_ivsmultitrackinpconf(
    iv_enabled = ABAP_TRUE
    iv_maximumresolution = |string|
    iv_policy = |string|
  )
  iv_arn = |string|
  iv_authorized = ABAP_TRUE
  iv_containerformat = |string|
  iv_insecureingest = ABAP_TRUE
  iv_latencymode = |string|
  iv_name = |string|
  iv_playbackrestrictionplyarn = |string|
  iv_preset = |string|
  iv_recordingconfigurationarn = |string|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_channel = lo_result->get_channel( ).
  IF lo_channel IS NOT INITIAL.
    lv_channelarn = lo_channel->get_arn( ).
    lv_channelname = lo_channel->get_name( ).
    lv_channellatencymode = lo_channel->get_latencymode( ).
    lv_channeltype = lo_channel->get_type( ).
    lv_channelrecordingconfigu = lo_channel->get_recordingconfarn( ).
    lv_ingestendpoint = lo_channel->get_ingestendpoint( ).
    lv_playbackurl = lo_channel->get_playbackurl( ).
    lv_isauthorized = lo_channel->get_authorized( ).
    LOOP AT lo_channel->get_tags( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_tagvalue = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_insecureingest = lo_channel->get_insecureingest( ).
    lv_transcodepreset = lo_channel->get_preset( ).
    lo_srt = lo_channel->get_srt( ).
    IF lo_srt IS NOT INITIAL.
      lv_srtendpoint = lo_srt->get_endpoint( ).
      lv_srtpassphrase = lo_srt->get_passphrase( ).
    ENDIF.
    lv_channelplaybackrestrict = lo_channel->get_playbackrestrictionply00( ).
    lo_multitrackinputconfigur = lo_channel->get_multitrackinputconf( ).
    IF lo_multitrackinputconfigur IS NOT INITIAL.
      lv_ismultitrackinputenable = lo_multitrackinputconfigur->get_enabled( ).
      lv_multitrackpolicy = lo_multitrackinputconfigur->get_policy( ).
      lv_multitrackmaximumresolu = lo_multitrackinputconfigur->get_maximumresolution( ).
    ENDIF.
    lv_containerformat = lo_channel->get_containerformat( ).
  ENDIF.
ENDIF.