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

Consulta os detalhes dos parâmetros de uma tarefa de mixagem e retransmissão de streams.

Descrição da operação

Esta operação consulta os detalhes dos parâmetros de uma tarefa de mixagem e retransmissão de streams. Apenas tarefas de mixagem e retransmissão de streams criadas por meio de operações de API podem ser consultadas.
Para uma consulta paginada, os resultados da consulta são classificados pela hora de atualização da tarefa em ordem decrescente por padrão.

Limite de QPS

O limite de QPS por usuário para esta operação é de 50 chamadas por segundo. Se o limite for excedido, a invocação da API será limitada, o que pode afetar seus negócios. Invoque 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:ListRtcMPUTaskDetail

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID do aplicativo. Nota O ID do aplicativo consiste em letras maiúsculas e minúsculas, dígitos, sublinhados e hifens (-), com no máximo 64 caracteres.	yourAppId
TaskId	string	Não	O ID da tarefa. Nota O ID da tarefa consiste em letras maiúsculas e minúsculas, dígitos, sublinhados e hifens (-), com no máximo 55 caracteres. Se você especificar um ID de tarefa, a consulta será realizada primeiro com base no ID da tarefa, e o resultado conterá os detalhes dos parâmetros da tarefa de mixagem e retransmissão de streams com o ID de tarefa especificado.	yourTaskId
PageSize	integer	Não	O número de registros por página. Valores válidos: 1 a 100. Nota Se você não especificar um ID de tarefa, deverá especificar os parâmetros PageSize e PageNo. Nesse caso, os resultados da consulta paginada de todas as tarefas de mixagem e retransmissão de streams sob o ID do aplicativo especificado serão retornados.	10
PageNo	integer	Não	O número da página. Nota Se você não especificar um ID de tarefa, deverá especificar os parâmetros PageSize e PageNo. Nesse caso, os resultados da consulta paginada de todas as tarefas de mixagem e retransmissão de streams sob o ID do aplicativo especificado serão retornados.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	****3B-0E1A-586A-AC29-742247****
MPUTasks	array<object>	Os detalhes dos parâmetros da tarefa. O formato do parâmetro é o mesmo que o formato usado quando você chama a operação para criar uma tarefa de mixagem de streams.
	array<object>
AppId	string	O ID do aplicativo.	yourAppId
ChannelId	string	O ID do canal.	yourChannelId
TaskId	string	O ID da tarefa. Este ID é o identificador da tarefa de mixagem e retransmissão de streams.	yourTaskId
MixMode	string	O modo de mixagem de streams. Valores válidos: 0: retransmissão de stream única sem mixagem ou transcodificação de streams. Apenas a stream única original é retransmitida. Não é necessário configurar parâmetros de mixagem e transcodificação de streams. 1 (padrão): mixagem, transcodificação e retransmissão de streams.	0
StreamURL	string	A URL de ingestão da live stream.	rtmp://example.com/live/stream****
MultiStreamURL	array<object>	Os parâmetros de retransmissão para múltiplos endereços.
	object
URL	string	A URL de ingestão.	rtmp://example.com/live/stream****
IsAliCdn	boolean	Indica se a retransmissão de stream é realizada usando o Alibaba Cloud CDN. Valores válidos: false: A retransmissão de stream é realizada usando um serviço de CDN que não é o Alibaba Cloud CDN. true: A retransmissão de stream é realizada usando o Alibaba Cloud CDN.	false
Region	string	A região onde reside o serviço de mixagem de streams solicitado. Valores válidos: CN-Shanghai: Xangai. AP-Singapore (padrão): Singapura. EMAA-Saudi: Arábia Saudita.	CN-Shanghai
MaxIdleTime	string	O período de tempo limite de ociosidade. Unidade: segundos. Nota Se este parâmetro for definido, a tarefa será interrompida automaticamente quando ficar ociosa por um período superior ao MaxIdleTime. Se este parâmetro não for definido, a tarefa será interrompida imediatamente após o fechamento do canal.	10
SingleSubParams	object	Os parâmetros de retransmissão de stream única.
SourceType	string	A origem do vídeo. Este parâmetro é válido apenas se você definir StreamType como 2. Valores válidos: camera (padrão): captura o vídeo usando uma câmera. shareScreen: captura o conteúdo exibido em uma tela.	camera
StreamType	string	O tipo de stream que é retransmitido. Valores válidos: 0 (padrão): o stream original. 1: o stream apenas de áudio. 2: o stream apenas de vídeo.	0
UserId	string	O ID do usuário cujo stream é retransmitido. No modo de retransmissão de stream único, você pode retransmitir apenas um stream em uma solicitação.	yourSubUserId
TranscodeParams	object	Os parâmetros de mixagem, transcodificação e retransmissão de streams.
Background	object	A imagem de fundo global.
RenderMode	string	O modo de exibição. Valores válidos: 0: dimensiona proporcionalmente o vídeo ou a imagem de fundo para caber no painel. Barras pretas são adicionadas para preencher o espaço extra. 1 (padrão): corta o vídeo ou a imagem de fundo para caber no painel.	1
URL	string	A URL da imagem de fundo global.	yourImageUrl
EncodeParams	object	Os parâmetros de codificação do stream de saída.
AudioOnly	string	Indica se o stream de saída é um stream apenas de áudio. Valores válidos: true false (padrão)	false
AudioBitrate	string	A taxa de bits do áudio. Unidade: Kbit/s.	128
AudioChannels	string	O número de canais de áudio. Valores válidos: 1 e 2.	2
AudioSampleRate	string	A taxa de amostragem de áudio. Unidade: Hz.	44100
VideoCodec	string	O formato de codificação de vídeo. Valor padrão: H.264.	H.264
VideoBitrate	string	A taxa de bits do vídeo. Unidade: Kbit/s.	3500
VideoFramerate	string	A taxa de quadros do vídeo. Unidade: quadros por segundo (FPS).	25
VideoGop	string	O tamanho do grupo de imagens (GOP) do vídeo.	20
VideoHeight	string	A altura do vídeo. Unidade: pixels.	1000
VideoWidth	string	A largura do vídeo. Unidade: pixels.	1920
EnhancedParam	string	O parâmetro para codificação avançada de vídeo. O valor é uma string JSON. Campos opcionais: profile: o nível de codificação. Se o formato de codificação de vídeo estiver definido como H.264, os valores válidos deste campo são baseline, main e high. preset: ajusta o equilíbrio entre a velocidade de codificação e a qualidade do vídeo. Valores válidos: ultrafast, superfast, veryfast, faster, fast, medium, slow, slower, veryslow e placebo. Cada valor especifica um nível de equilíbrio entre a velocidade de codificação e a qualidade do vídeo. Por exemplo, o preset ultrafast tem a velocidade de codificação mais rápida, mas a qualidade de vídeo mais baixa, enquanto o preset placebo sacrifica a velocidade de codificação para obter a melhor qualidade de vídeo.	{"profile": "high", "preset": "veryfast"}
Layout	object	As informações de layout do vídeo. Nota As informações de layout do vídeo incluem a coordenada x, coordenada y, largura, altura e camada do painel. Para transcodificação apenas de áudio, nenhuma informação de layout de vídeo é retornada.
UserPanes	array<object>	As informações sobre os painéis.
	array<object>
UserInfo	object	As informações sobre o usuário cujo stream é reproduzido no painel.
SourceType	string	A origem do vídeo. Este parâmetro é válido apenas se você definir StreamType como 2. Valores válidos: camera (padrão): captura o vídeo usando uma câmera. shareScreen: captura o conteúdo exibido em uma tela.	camera
ChannelId	string	O ID do canal onde o usuário está.	yourChannelId
UserId	string	O ID do usuário.	yourSubUserId
Height	string	A altura do painel. O valor é normalizado.	0.2632
Width	string	A largura do painel. O valor é normalizado.	0.3564
X	string	A coordenada x do painel. O valor é normalizado.	0.2456
Y	string	A coordenada y do painel. O valor é normalizado.	0.3789
ZOrder	string	A camada do painel. Um valor de 0 indica que o painel é colocado na camada inferior. Um valor maior indica uma camada superior.	0
BackgroundImageUrl	string	A URL da imagem de fundo do painel. Esta imagem é exibida se o usuário desligar a câmera ou não estiver presente no canal.	yourImageUrl
RenderMode	string	O modo de exibição. Valores válidos: 0: dimensiona proporcionalmente o vídeo ou a imagem de fundo para caber no painel. Barras pretas são adicionadas para preencher o espaço extra. 1 (padrão): corta o vídeo ou a imagem de fundo para caber no painel.	1
UserInfos	array<object>	As informações sobre o usuário cujo stream é mixado. Se um valor vazio for retornado, os streams de todos os usuários serão mixados.
	object
ChannelId	string	O ID do canal onde o usuário está.	yourChannelId
UserId	string	O ID do usuário.	yourSubUserId
SourceType	string	A origem do vídeo. Este parâmetro é válido apenas se você definir StreamType como 2. Valores válidos: camera (padrão): captura o vídeo usando uma câmera. shareScreen: captura o conteúdo exibido em uma tela.	camera
StreamType	string	O tipo de stream que é retransmitido. Valores válidos: 0 (padrão): o stream original. 1: o stream apenas de áudio. 2: o stream apenas de vídeo.	0
SeiParams	object	Os parâmetros de configuração SEI.
LayoutVolume	object	O SEI de layout e volume. Se o valor retornado for uma string vazia, o SEI de layout e volume padrão será usado.
FollowIdr	string	Indica se devem ser adicionadas mensagens SEI aos quadros de Instantaneous Decoder Refresh (IDR). Valores válidos: 0: não adiciona mensagens SEI. 1: adiciona mensagens SEI.	0
Interval	string	O intervalo no qual as mensagens SEI são adicionadas. Unidade: milissegundos.	1000
PassThrough	object	O SEI personalizado.
FollowIdr	string	Indica se devem ser adicionadas mensagens SEI aos quadros de Instantaneous Decoder Refresh (IDR). Valores válidos: 0: não adiciona mensagens SEI. 1: adiciona mensagens SEI.	0
Interval	string	O intervalo no qual as mensagens SEI são adicionadas. Unidade: milissegundos.	1000
PayloadContent	string	O conteúdo da carga útil do SEI personalizado.	yourPayloadContent
PayloadContentKey	string	A chave do conteúdo da carga útil. Valor padrão: udd.	yourPayloadContentKey
PayloadType	string	O tipo de carga útil personalizado. Valores válidos: 100 a 254. Valor padrão: 5.	100

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "MPUTasks": [
    {
      "AppId": "yourAppId",
      "ChannelId": "yourChannelId",
      "TaskId": "yourTaskId",
      "MixMode": "0",
      "StreamURL": "rtmp://example.com/live/stream****",
      "MultiStreamURL": [
        {
          "URL": "rtmp://example.com/live/stream****",
          "IsAliCdn": false
        }
      ],
      "Region": "CN-Shanghai",
      "MaxIdleTime": "10",
      "SingleSubParams": {
        "SourceType": "camera",
        "StreamType": "0",
        "UserId": "yourSubUserId"
      },
      "TranscodeParams": {
        "Background": {
          "RenderMode": "1",
          "URL": "yourImageUrl"
        },
        "EncodeParams": {
          "AudioOnly": "false",
          "AudioBitrate": "128",
          "AudioChannels": "2",
          "AudioSampleRate": "44100",
          "VideoCodec": "H.264",
          "VideoBitrate": "3500",
          "VideoFramerate": "25",
          "VideoGop": "20",
          "VideoHeight": "1000",
          "VideoWidth": "1920",
          "EnhancedParam": "{\"profile\": \"high\", \"preset\": \"veryfast\"}"
        },
        "Layout": {
          "UserPanes": [
            {
              "UserInfo": {
                "SourceType": "camera",
                "ChannelId": "yourChannelId",
                "UserId": "yourSubUserId"
              },
              "Height": "0.2632",
              "Width": "0.3564",
              "X": "0.2456",
              "Y": "0.3789",
              "ZOrder": "0",
              "BackgroundImageUrl": "yourImageUrl",
              "RenderMode": "1"
            }
          ]
        },
        "UserInfos": [
          {
            "ChannelId": "yourChannelId",
            "UserId": "yourSubUserId",
            "SourceType": "camera",
            "StreamType": "0"
          }
        ]
      },
      "SeiParams": {
        "LayoutVolume": {
          "FollowIdr": "0",
          "Interval": "1000"
        },
        "PassThrough": {
          "FollowIdr": "0",
          "Interval": "1000",
          "PayloadContent": "yourPayloadContent",
          "PayloadContentKey": "yourPayloadContentKey"
        },
        "PayloadType": "100"
      }
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParam	%s.	Falha na validação do parâmetro.
400	InvalidAppId	%s, please check and try again later.	O AppId é inválido. Verifique e tente novamente.
400	MissingParam	%s, please check and try again later.	Parâmetros obrigatórios estão ausentes. Verifique e tente novamente.
500	InternalError	%s, please try again later.	Ocorreu um erro interno. Tente novamente mais tarde.
403	OperationDenied	Your account has not enabled the Live service
403	Forbidden	%s, please check and try again later.	Você não tem as permissões necessárias. Verifique e tente novamente.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.