Help Center/ Meeting/ Server API Reference/ Meeting Control/ APIs/ Switching the Video Display Mode
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF

Switching the Video Display Mode

Description

This API is used to switch the video display policy in a meeting, including broadcasting continuous presence, broadcasting a single pane, and voice-activated 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/mode

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.

switchMode

Yes

String

Body

Video meeting display mode.

  • Fixed: The specified participant is displayed on the main screen.
  • VAS: voice activation. The participant who speaks most loudly is displayed on the main screen.

imageType

Yes

Integer

Body

Layout type. The single-screen layout applies only to the voice activation mode.

  • 0: single-screen layout.
  • 1: continuous presence.

Status Codes

Table 3 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/mode?conferenceID=914083136
Connection: keep-alive
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
Content-Type: application/json
Content-Length: 52
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
 "switchMode":"Fixed",
 "imageType":1
}

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: 6b7ed88a1b11fe1b4fbb5f05aaff37c4
Server: api-gateway
X-Request-Id: 85ac4acb4942810fd3ce179134cbd4e2

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 '{"switchMode":"Fixed","imageType":"1"}' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/display/mode?conferenceID=914083136'
Parent topic: APIs