Help Center/ Meeting/ Server API Reference/ Meeting Control/ APIs/ Setting Continuous Presence
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Setting Continuous Presence

Description

This API is used to set continuous presence. This API is deprecated. Use the API for customizing continuous presence.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

PUT

Request Address

/v1/mmc/control/conferences/display/multiPicture

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

conferenceID

Yes

String

Query

Meeting ID.

X-Conference-Authorization

Yes

String

Header

Meeting control token, which can be obtained by calling the API for Obtaining a Meeting Control Token.

manualSet

Yes

Integer

Body

Whether to customize continuous presence.

  • 0: no. The automatic continuous presence is used.
  • 1: yes.

imageType

No

String

Body

Number of screens. This parameter is valid when manualSet is set to 1.

  • Single: single screen.
  • Two: two screens.
  • Three: three screens.
  • Four: four screens.
  • Six: six screens.
  • Nine: nine screens.
  • Sixteen: 16 screens.

subscriberInPics

No

Array of SubscriberInPic objects

Body

Screen list. This parameter is mandatory when you manually set continuous presence.

switchTime

No

Integer

Body

Interval of displaying participants. Value range: 10 to 120. The default value is 10. Unit: second.

This parameter is valid only for multi-screen layouts.
Table 3 SubscriberInPic data structure

Parameter

Mandatory

Type

Description

index

Yes

Integer

Sequence number of each screen in continuous presence. The sequence number starts from 1.

Default value: 1.

subscriber

No

Array of strings

Participant ID list in each screen. Set this parameter to the value of pid obtained by calling the API for Querying Meeting Details in Real Time.

isAssistStream

No

Integer

Whether a stream is a presentation. Default value: 0.

  • 0: no.
  • 1: yes.

Status Codes

Table 4 Status codes

HTTP Status Code

Description

200

Operation successful.

400

Invalid parameters.

401

Authentication is not performed or fails.

403

Insufficient permissions.

500

Server exception.

Response Parameters

None

Example Request

PUT /v1/mmc/control/conferences/display/multiPicture?conferenceID=914083136
Connection: keep-alive
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
Content-Type: application/json
Content-Length: 27
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
 "manualSet": 0
}

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 39
Connection: keep-alive
http_proxy_id: 6346df97898dcd1e9cb205b75f24fe65
Server: api-gateway
X-Request-Id: 0294dd7aedd58db92a23de453cbcde0e

Error Codes

If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.

Example cURL Command

curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"manualSet": 0}' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/display/multiPicture?conferenceID=914083136'
Parent topic: APIs