/AWS1/IF_CHM=>UPDATEATTENDEECAPABILITIES()¶
About UpdateAttendeeCapabilities¶
The capabilities that you want to update.
You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see
.
When using capabilities, be aware of these corner cases:
-
If you specify
MeetingFeatures:Video:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Videowill be rejected withValidationError 400. -
If you specify
MeetingFeatures:Content:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Contentwill be rejected withValidationError 400. -
You can't set
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. -
If meeting features is defined as
Video:MaxResolution:NonebutContent:MaxResolutionis defined as something other thanNoneand attendee capabilities are not defined in the API request, then the default attendee video capability is set toReceiveand attendee content capability is set toSendReceive. This is because contentSendReceiverequires video to be at leastReceive. -
When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
Method Signature¶
METHODS /AWS1/IF_CHM~UPDATEATTENDEECAPABILITIES
IMPORTING
!IV_MEETINGID TYPE /AWS1/CHMGUIDSTRING OPTIONAL
!IV_ATTENDEEID TYPE /AWS1/CHMGUIDSTRING OPTIONAL
!IO_CAPABILITIES TYPE REF TO /AWS1/CL_CHMATTENDEECAPABILI00 OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chmupattendeecapabi01
RAISING
/AWS1/CX_CHMBADREQUESTEX
/AWS1/CX_CHMCONFLICTEXCEPTION
/AWS1/CX_CHMFORBIDDENEXCEPTION
/AWS1/CX_CHMNOTFOUNDEXCEPTION
/AWS1/CX_CHMSERVICEFAILUREEX
/AWS1/CX_CHMSERVICEUNAVAILEX
/AWS1/CX_CHMTHROTTLINGEX
/AWS1/CX_CHMUNAUTHORIZEDEX
/AWS1/CX_CHMCLIENTEXC
/AWS1/CX_CHMSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_meetingid TYPE /AWS1/CHMGUIDSTRING /AWS1/CHMGUIDSTRING¶
The ID of the meeting associated with the update request.
iv_attendeeid TYPE /AWS1/CHMGUIDSTRING /AWS1/CHMGUIDSTRING¶
The ID of the attendee associated with the update request.
io_capabilities TYPE REF TO /AWS1/CL_CHMATTENDEECAPABILI00 /AWS1/CL_CHMATTENDEECAPABILI00¶
The capabilities that you want to update.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_chmupattendeecapabi01 /AWS1/CL_CHMUPATTENDEECAPABI01¶
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->updateattendeecapabilities(
io_capabilities = new /aws1/cl_chmattendeecapabili00(
iv_audio = |string|
iv_content = |string|
iv_video = |string|
)
iv_attendeeid = |string|
iv_meetingid = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
lo_attendee = lo_result->get_attendee( ).
IF lo_attendee IS NOT INITIAL.
lv_externaluserid = lo_attendee->get_externaluserid( ).
lv_guidstring = lo_attendee->get_attendeeid( ).
lv_jointokenstring = lo_attendee->get_jointoken( ).
lo_attendeecapabilities = lo_attendee->get_capabilities( ).
IF lo_attendeecapabilities IS NOT INITIAL.
lv_mediacapabilities = lo_attendeecapabilities->get_audio( ).
lv_mediacapabilities = lo_attendeecapabilities->get_video( ).
lv_mediacapabilities = lo_attendeecapabilities->get_content( ).
ENDIF.
ENDIF.
ENDIF.