Personalização a presença contínua
Descrição
Esta API é usada para personalizar a presença contínua em uma reunião.
Depuração
Você pode depurar essa API no API Explorer.
Protótipo
Método de solicitação |
PUT |
---|---|
Endereço de solicitação |
/v1/mmc/control/conferences/display/customMultiPicture |
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Localização |
Descrição |
---|---|---|---|---|
conferenceID |
Sim |
String |
Consulta |
ID da reunião. |
X-Conference-Authorization |
Sim |
String |
Cabeçalho |
Token de controle de reunião, que é obtido através da API para obter um token de controle de reunião. |
manualSet |
Sim |
Integer |
Corpo |
Se personalizar manualmente a presença contínua.
|
picLayoutInfo |
Não |
PicLayoutInfo object |
Corpo |
Presença contínua personalizada.
NOTA:
Este parâmetro não está disponível na versão atual. |
imageType |
Não |
String |
Corpo |
Tipo de layout. Esse parâmetro é válido quando você configura manualmente a presença contínua. Para obter detalhes sobre o mapeamento entre valores de imageType e layouts, consulte Figura 1. |
subscriberInPics |
Não |
Array of SubscriberInPic objects |
Corpo |
Lista de telas. Este parâmetro é obrigatório quando você configura manualmente a presença contínua. |
switchTime |
Não |
Integer |
Corpo |
Intervalo de exibição dos participantes. Intervalo de valores: 10 a 120. O valor padrão é 10. Unidade: segundo. Esse parâmetro é válido somente para layouts de várias telas. |
multiPicSaveOnly |
Não |
Boolean |
Corpo |
Se salvar apenas a presença contínua.
Salvar presença contínua apenas não transmitirá presença contínua. Salvar e aplicar presença contínua: Quando o status da reunião estiver transmitindo presença contínua, tela única ativada por voz, presença contínua ativada por voz ou exibindo presença contínua para o anfitrião, salvar e aplicar presença contínua alterará o layout da tela sem alterar o status da reunião. Quando uma reunião está em outros status, por exemplo, presença contínua automática, transmissão de um participante ou dar a palavra a um participante, salvar e aplicar presença contínua alterará o status da reunião para transmissão de presença contínua. Durante a transmissão de presença contínua, presença contínua ativada por voz ou tela única ativada por voz, você não pode exibir a presença contínua para o anfitrião. |
Os valores de imageType são exibidos abaixo dos diagramas de layout. Por exemplo, para definir o layout de presença contínua para quatro telas do mesmo tamanho, defina imageType como Four.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
x |
Não |
Integer |
Largura do layout de presença contínua. |
y |
Não |
Integer |
Altura do layout de presença contínua. |
subPicLayoutInfoList |
Não |
Array of SubPicLayoutInfo objects |
Lista de telas no layout. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
id |
Não |
Integer |
ID da tela. |
left |
Não |
Integer |
Coordenadas da tela da esquerda para a direita. |
top |
Não |
Integer |
Coordenadas da tela de cima para baixo. |
xSize |
Não |
Integer |
Largura da tela. |
ySize |
Não |
Integer |
Altura da tela. |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
index |
Não |
Integer |
Número de sequência de cada tela em presença contínua. O número de sequência começa a partir de 1. Valor padrão: 1. |
subscriber |
Não |
Array of strings |
Lista de ID do participante em cada tela. O valor pode ser o número SIP ou número SIP#tipo de terminal. O número SIP é obtido chamando a API para consultar detalhes da reunião em tempo real. |
isAssistStream |
Não |
Integer |
Se um fluxo é uma apresentação. Valor padrão: 0.
|
Códigos de status
Código de status HTTP |
Descrição |
---|---|
200 |
Operação bem-sucedida. |
400 |
Parâmetros inválidos. |
401 |
A autenticação não é executada ou falha. |
403 |
Permissões insuficientes. |
500 |
Exceção do servidor. |
Parâmetros de resposta
Nenhum
Exemplo de solicitação
PUT /v1/mmc/control/conferences/display/customMultiPicture?conferenceID=900967789 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": 1, "subscriberInPics":[{ "index": 2, "subscriber": ["+99111252010982686"] }], "imageType":"Six", "multiPicSaveOnly": "false" }
Exemplo de resposta
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
Códigos de erro
Se um código de erro começando com MMC ou USG for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas no Centro de erros da API da Huawei Cloud.
Exemplo de comando cURL
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/customMultiPicture?conferenceID=900967789'