Atualiza uma tarefa de gravação em nuvem do RTC.
Descrição da operação
A gravação de fluxo único oferece suporte à atualização dos parâmetros de assinatura. A gravação de fluxo misto oferece suporte apenas à atualização dos fluxos de usuários assinados.
Limites de QPS
O limite de consultas por segundo (QPS) para um único usuário é 50. Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus serviços. Faça chamadas de API em uma taxa razoável.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
live:UpdateRtcCloudRecording |
update |
*Todos os recursos.
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| TaskId |
string |
Sim |
O ID da tarefa. Este ID é retornado por StartRtcCloudRecording. Você só pode atualizar tarefas que estão em execução ou em estado anormal. |
******73-8501-****-8ac1-72295a****** |
| SubscribeParams |
object |
Sim |
Os parâmetros de assinatura atualizados. |
|
| SubscribeUserIdList |
array<object> |
Sim |
A lista de IDs de usuários assinados. No modo de gravação de fluxo único, cada ID de usuário é gravado separadamente. No modo de gravação de fluxo misto, os fluxos de áudio e vídeo de todos os IDs de usuários são misturados em um único fluxo de áudio e vídeo. Nota
|
|
|
object |
Não |
As informações sobre o ID do usuário assinado. |
||
| UserId |
string |
Sim |
O ID do usuário assinado. |
userA |
| StreamType |
integer |
Não |
O tipo de mídia do ID do usuário assinado. Valores válidos:
Valores válidos:
|
0 |
| SourceType |
integer |
Não |
O tipo de fluxo de entrada de vídeo do ID do usuário. Este parâmetro é válido apenas quando um fluxo de vídeo é assinado (StreamType=2). Valores válidos:
Valores válidos:
|
0 |
| MixLayoutParams |
object |
Não |
Os parâmetros de layout atualizados. Este parâmetro não é obrigatório no modo de gravação de fluxo único. No modo de gravação de fluxo misto, este parâmetro é obrigatório, a menos que a transcodificação seja apenas de áudio. |
|
| MixBackground |
object |
Não |
A imagem de fundo global para a mistura de fluxos. |
|
| RenderMode |
integer |
Não |
O modo de exibição para a saída de vídeo. Valores válidos:
Valores válidos:
|
0 |
| Url |
string |
Não |
A URL da imagem de fundo. O comprimento máximo é de 2.048 caracteres. |
https://xxxx.com/photos/my-test-picture.png |
| UserPanes |
array<object> |
Não |
As informações de layout de janela para os usuários assinados. Apenas os IDs de usuários com informações de layout configuradas são exibidos no vídeo. Este parâmetro é obrigatório no modo de gravação de fluxo misto quando a gravação não é apenas de áudio. |
|
|
array<object> |
Não |
A configuração da janela no vídeo. |
||
| UserId |
string |
Não |
O ID do usuário correspondente à janela.
|
userA |
| SourceType |
integer |
Não |
O tipo de fluxo de entrada de vídeo do ID do usuário. Se o UserId não for especificado, a configuração de SourceType aqui será inválida. Valores válidos:
A combinação de UserId e SourceType especificada aqui deve estar incluída em SubscribeUserIdList. Valores válidos:
|
0 |
| Height |
string |
Não |
A altura do painel, como uma porcentagem normalizada. O valor deve estar no intervalo de [0,1]. Valor padrão: 0. |
0.5 |
| Width |
string |
Não |
A largura do painel, como uma porcentagem normalizada. O valor deve estar no intervalo de [0,1]. Valor padrão: 0. |
0.5 |
| X |
string |
Não |
A coordenada X, como uma porcentagem normalizada. O valor deve estar no intervalo de [0,1]. Valor padrão: 0. |
0 |
| Y |
string |
Não |
A coordenada Y, como uma porcentagem normalizada. O valor deve estar no intervalo de [0,1]. Valor padrão: 0. |
0 |
| ZOrder |
integer |
Não |
A ordem de empilhamento. 0 indica a camada inferior, 1 indica a camada acima de 0 e assim por diante. Valor padrão: 0. |
0 |
| SubBackground |
object |
Não |
A imagem de fundo da subimagem. Quando um usuário desliga a câmera, não ingere um fluxo após entrar no canal ou sai do canal no meio do caminho, a imagem correspondente é exibida na posição do layout. |
|
| RenderMode |
integer |
Não |
O modo de exibição para a saída da subimagem. Valores válidos:
Valores válidos:
|
0 |
| Url |
string |
Não |
A URL da imagem de fundo. O comprimento máximo é de 2.048 caracteres. |
https://xxxx.com/photos/my-test-pane-picture.png |
-
Você pode assinar os fluxos de câmera e de compartilhamento de tela do mesmo ID de usuário ao mesmo tempo. No modo de gravação de fluxo único, se você quiser assinar os fluxos de câmera e de compartilhamento de tela do mesmo ID de usuário, os parâmetros FileNamePattern e SliceNamePattern devem incluir a variável SourceType para evitar que os arquivos de gravação se sobrescrevam.
-
No modo de gravação de fluxo único, não há suporte para assinar apenas o fluxo apenas de vídeo de um ID de usuário. Ou seja, o valor de UserInfo.StreamType não pode ser definido como 2 no modo de fluxo único.
-
Se você quiser gravar apenas o fluxo de tela de um ID de usuário sem o fluxo de áudio, poderá assinar o fluxo apenas de vídeo do ID do usuário e definir SourceType como 1 (não suportado no modo de gravação de fluxo único), ou assinar o fluxo original do ID do usuário e ingerir apenas o fluxo de tela sem ingerir o fluxo de áudio ou silenciar o áudio. Se você quiser gravar tanto o fluxo de tela quanto o fluxo de áudio de um ID de usuário, poderá assinar o fluxo original do ID do usuário e ingerir apenas o fluxo de tela junto com o fluxo de áudio, ou assinar o fluxo apenas de vídeo do ID do usuário e definir SourceType como 1 (não suportado no modo de gravação de fluxo único) e também assinar o fluxo apenas de áudio do ID do usuário.
-
No modo de gravação de fluxo único, se RecordParams.StreamType estiver definido como fluxo apenas de áudio (1), SubscribeParams não poderá conter assinaturas para fluxos apenas de vídeo (2). Se RecordParams.StreamType estiver definido como fluxo apenas de vídeo (2), SubscribeParams não poderá conter assinaturas para fluxos apenas de áudio (1).
-
No modo de gravação de fluxo misto, se RecordParams.StreamType estiver definido como fluxo apenas de áudio (1), nem todos os IDs de usuário em SubscribeParams poderão assinar apenas fluxos apenas de vídeo (2). Se RecordParams.StreamType estiver definido como fluxo apenas de vídeo (2), nem todos os IDs de usuário em SubscribeParams poderão assinar apenas fluxos apenas de áudio (1).
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Esquema da resposta. |
||
| RequestId |
string |
O ID da solicitação. |
******58-5876-****-83CA-B56278****** |
| TaskId |
string |
O ID da tarefa. |
******73-8501-****-8ac1-72295a****** |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "******58-5876-****-83CA-B56278******\n",
"TaskId": "******73-8501-****-8ac1-72295a******\n"
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | NotFound.Task | %s, please check the TaskId. | O parâmetro TaskId especificado não existe. |
| 400 | InvalidParameter.TaskId | %s, please check the TaskId. | A tarefa especificada deve estar no estado Running ou Recovering. |
| 400 | InvalidParameter.SubscribeParams.SubscribeUserIdList | %s, please check the subscribeUserIdList of subscribeParams. | O parâmetro SubscribeUserIdList é inválido. Verifique o parâmetro. |
| 400 | InvalidParameter.MixLayoutParams.UserPanes | %s, please check the userPanes of mixLayoutParams. | O parâmetro UserPanes contém campos inválidos. Verifique o parâmetro. |
| 400 | InvalidParameter.MixTranscodeParams | %s, please check the transcodeParams. | O parâmetro MixTranscodeParams contém campos inválidos. Verifique o parâmetro. |
| 400 | MissingParameter | %s. | Um parâmetro obrigatório está ausente. |
| 403 | InvalidParameter.UserId | %s, please check the UserId. | O UserId é inválido. Verifique o parâmetro. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.