UpdateRtcCloudRecording - ApsaraVideo Live: Central de Documentação do Alibaba Cloud

Atualiza uma tarefa de gravação em nuvem RTC.

Descrição da operação

A gravação de stream único suporta a atualização de parâmetros de assinatura. A gravação de mixagem de streams suporta a atualização apenas dos streams de usuários assinados.

Limite de QPS

O limite de QPS por usuário para esta operação é de 50 chamadas por segundo. Se esse limite for excedido, a chamada de API será limitada, o que pode afetar seus negócios. Chame esta operação conforme necessário.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

live:UpdateRtcCloudRecording

update

*All Resource

*

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. Apenas tarefas no estado em execução ou anormal podem ser atualizadas.	****73-8501--8ac1-72295a****
SubscribeParams	object	Sim	Os parâmetros de assinatura atualizados.
SubscribeUserIdList	array<object>	Sim	A lista de entradas de UserId assinados. No modo de gravação de stream único, cada UserId é gravado separadamente. No modo de gravação de mixagem de streams, o áudio e o vídeo de todos os UserIds são mixados em um único conjunto de áudio e vídeo. Nota O array suporta no máximo 17 elementos.
	object	Não	As informações sobre o UserId assinado.
UserId	string	Sim	O UserId assinado.	userA
StreamType	integer	Não	O tipo de mídia do UserId assinado. Valores válidos: 0: stream original, que inclui áudio e vídeo. (Padrão) 1: stream somente áudio. 2: stream somente vídeo. Valores válidos: 0 : stream original, que inclui áudio e vídeo. 1 : stream somente áudio. 2 : stream somente vídeo.	0
SourceType	integer	Não	O tipo de stream de entrada de vídeo do UserId. Este parâmetro entra em vigor apenas quando o stream de vídeo é assinado (StreamType=2). Valores válidos: 0: câmera. (Padrão) 1: compartilhamento de tela. Valores válidos: 0 : câmera. 1 : compartilhamento de tela.	0
MixLayoutParams	object	Não	Os parâmetros de layout atualizados. Deixe este parâmetro vazio no modo de gravação de stream único. Este parâmetro é obrigatório no modo de gravação de mixagem de streams quando a saída de transcodificação não é somente áudio.
MixBackground	object	Não	A imagem de fundo global para mixagem de streams.
RenderMode	integer	Não	O modo de exibição para a saída. Valores válidos: 0: cortar. (Padrão) 1: dimensionar e exibir com bordas pretas. Valores válidos: 0 : cortar. 1 : dimensionar e exibir com bordas pretas.	0
Url	string	Não	A URL da imagem de fundo. O comprimento máximo é de 2048 caracteres.	https://xxxx.com/photos/my-test-picture.png
UserPanes	array<object>	Não	As informações de layout de janela dos usuários assinados. Apenas UserIds com informações de layout configuradas são posicionados na saída. Este parâmetro é obrigatório no modo de mixagem de streams ao gravar arquivos que não são somente áudio.
	array<object>	Não	A configuração de janela na saída.
UserId	string	Não	O UserId correspondente a esta janela. Se UserId não for especificado, as janelas são preenchidas na ordem em que os usuários assinados entram no canal. A combinação de UserId e SourceType especificada aqui deve estar incluída em SubscribeUserIdList. Streams somente áudio não podem ser adicionados ao layout.	userA
SourceType	integer	Não	O tipo de stream de entrada de vídeo do UserId. Se UserId não for especificado, a configuração de SourceType é ignorada. Valores válidos: 0: câmera. (Padrão) 1: compartilhamento de tela. A combinação de UserId e SourceType especificada aqui deve estar incluída em SubscribeUserIdList. Valores válidos: 0 : câmera. 1 : compartilhamento de tela.	0
Height	string	Não	A altura do painel como porcentagem normalizada. O valor deve estar no intervalo de [0, 1]. (Padrão: 0).	0.5
Width	string	Não	A largura do painel como porcentagem normalizada. O valor deve estar no intervalo de [0, 1]. (Padrão: 0).	0.5
X	string	Não	A coordenada X como porcentagem normalizada. O valor deve estar no intervalo de [0, 1]. (Padrão: 0).	0
Y	string	Não	A coordenada Y como porcentagem normalizada. O valor deve estar no intervalo de [0, 1]. (Padrão: 0).	0
ZOrder	integer	Não	A ordem de empilhamento. 0 é a camada inferior, a camada 1 está acima da camada 0, e assim por diante. (Padrão: 0).	0
SubBackground	object	Não	A imagem de fundo do sub-painel. Quando um usuário desliga a câmera, não iniciou a ingestão de stream após entrar, ou sai do canal no meio, a imagem correspondente preenche a posição do layout.
RenderMode	integer	Não	The display mode for the sub-pane output. Valid values: 0: crop. (Default) 1: scale and display with black borders. Valores válidos: 0 : crop. 1 : scale and display with black borders.	0
Url	string	Não	The URL of the background image. The maximum length is 2048 characters.	https://xxxx.com/photos/my-test-pane-picture.png

A assinatura simultânea dos streams de câmera e compartilhamento de tela do mesmo UserId é suportada. No modo de gravação de stream único, se você deseja assinar tanto o stream de câmera quanto o de compartilhamento de tela do mesmo UserId, 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 stream único, a assinatura de um stream somente vídeo de um UserId específico não é suportada. Ou seja, no modo de stream único, UserInfo.StreamType não pode ser definido como 2.
Para gravar apenas o stream de tela de um UserId sem áudio, assine o stream somente vídeo do UserId e defina SourceType como 1 (não suportado no modo de gravação de stream único), ou assine o stream original do UserId e envie apenas o stream de tela sem enviar áudio ou com áudio silenciado durante a ingestão de stream. Para gravar tanto o stream de tela quanto o stream de áudio de um UserId, assine o stream original do UserId e envie apenas o stream de tela junto com o stream de áudio durante a ingestão de stream, ou assine o stream somente vídeo do UserId com SourceType definido como 1 (não suportado no modo de gravação de stream único) e também assine o stream somente áudio do mesmo UserId.
No modo de gravação de stream único, se RecordParams.StreamType for somente áudio (valor 1), SubscribeParams não deve conter nenhuma assinatura somente vídeo (valor 2). Se RecordParams.StreamType for somente vídeo (valor 2), SubscribeParams não deve conter nenhuma assinatura somente áudio (valor 1).
No modo de gravação de mixagem de streams, se RecordParams.StreamType for somente áudio (valor 1), nem todos os UserIds em SubscribeParams podem ser assinados como somente vídeo (valor 2). Se RecordParams.StreamType for somente vídeo (valor 2), nem todos os UserIds em SubscribeParams podem ser assinados como somente áudio (valor 1).

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema 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.	The parameter TaskId does not exist.
400	InvalidParameter.TaskId	%s, please check the TaskId.	The specified task must be in the running or recovering state.
400	InvalidParameter.SubscribeParams.SubscribeUserIdList	%s, please check the subscribeUserIdList of subscribeParams.	The parameter SubscribeUserIdList is invalid, please check.
400	InvalidParameter.MixLayoutParams.UserPanes	%s, please check the userPanes of mixLayoutParams.	The parameter UserPanes has invalid fields, please check.
400	InvalidParameter.MixTranscodeParams	%s, please check the transcodeParams.	The parameter MixTranscodeParams has invalid fields, please check.
400	MissingParameter	%s.	Missing parameter
403	InvalidParameter.UserId	%s, please check the UserId.	UserId is invalid, please check.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.