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

Consulta os layouts de um estúdio de produção.

Descrição da operação

Você pode chamar esta operação de API para consultar os layouts de um estúdio de produção. Se você não especificar um ID de layout, todos os layouts do estúdio serão retornados.

Limites de QPS

O limite de consultas por segundo (QPS) para esta operação de API é de 15 chamadas por segundo para cada usuário. Se você exceder esse limite, as chamadas de API serão limitadas. Isso pode afetar seus negócios, portanto, você deve chamar esta operação de API a uma taxa razoável.

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:DescribeCasterLayouts

get

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região.	cn-shanghai
CasterId	string	Sim	O ID do estúdio de produção. Se você criou o estúdio de produção chamando a operação CreateCaster, use o valor CasterId retornado na resposta. Se você criou o estúdio de produção no console LIVE, encontre o ID na página Estúdio de Produção > Estúdio de Produção em Nuvem. Nota O nome do estúdio de produção na lista da página Estúdio de Produção em Nuvem é o ID do estúdio de produção.	LIVEPRODUCER_POST-cn-0pp1czt****
LayoutId	string	Não	O ID do layout. Se você não fornecer um valor para LayoutId, todos os layouts do estúdio de produção serão retornados.	72d2ec7a-4cd7-4a01-974b-7cd53947****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Layouts	object
Layout	array<object>	A lista de layouts.
	array<object>	A lista de layouts.
AudioLayers	object
AudioLayer	array<object>	The list of AudioLayer configurations.
	object	The list of AudioLayer configurations.
FixedDelayDuration	integer	The fixed latency for the audio. This can be used for caption synchronization. Unit: milliseconds (ms). Default value: 0. Valid values: 0 to 5000.	20
ValidChannel	string	The sound channels that can be used for audio input. Valid values: leftChannel: The left sound channel. rightChannel: The right sound channel. all (default): Both sound channels.	all
VolumeRate	number	The volume rate. A value of 1 indicates the original volume. Nota The default value is 0. This displays the element in its original size.	1
BlendList	object
LocationId	array	The list of associated positions. The order is the same as that of VideoLayers.
	string	The position ID.	RV01
LayoutId	string	The layout ID.	72d2ec7a-4cd7-4a01-974b-7cd53947****
MixList	object
LocationId	array	The list of associated positions. The order is the same as that of AudioLayers.
	string	The position ID.	RV01
VideoLayers	object
VideoLayer	array<object>	The list of VideoLayer configurations. The default array sequence is used.
	array<object>	The list of VideoLayer configurations. The default array sequence is used.
FillMode	string	The fill mode of the element. Valid values: none (default): No fill. The layer is configured based on the video frame. fit: Fit. The layer is configured based on the fill area. The video frame is scaled with its original aspect ratio to fit the longer edge of the fill area and is centered. If the aspect ratio of the fill area is different from that of the video frame, the layer below is displayed in the unfilled areas. If no layer is configured below, the background is black.	fit
FixedDelayDuration	integer	The fixed latency set for the video. This can be used for caption synchronization. Unit: milliseconds (ms). Default value: 0. Valid values: 0 to 5000.	20
HeightNormalized	number	The normalized height of the layer element. If the fill mode is none, the width of the element is scaled proportionally based on this height. The default value is 0, which means the video is displayed in its original size. If the fill mode is fit, this parameter is required and must be greater than 0. It represents the normalized height of the fill area.	0.5
PositionNormalizeds	object
Position	array	The normalized position of the layer element in the format `[x,y]`. The default value is `[0,0]`. Nota The x and y coordinates must be normalized.
	number	The value.	0
PositionRefer	string	The reference point for the element's position. Valid values: topLeft (default): Top left. topRight: Top right. bottomLeft: Bottom left. bottomRight: Bottom right. center: Center. topCenter: Top center. bottomCenter: Bottom center. leftCenter: Left center. rightCenter: Right center.	topLeft
WidthNormalized	number	The normalized width of the layer element. If the fill mode is none, the height of the element is scaled proportionally based on this width. The default value is 0, which means the video is displayed in its original size. If the fill mode is fit, this parameter is required and must be greater than 0. It represents the normalized width of the fill area.	0.5
RequestId	string	O ID da solicitação.	3be7ade8-d907-483c-b24a-0dad45****
Total	integer	O número total de registros.	3

Exemplos

Resposta de sucesso

JSON formato

{
  "Layouts": {
    "Layout": [
      {
        "AudioLayers": {
          "AudioLayer": [
            {
              "FixedDelayDuration": 20,
              "ValidChannel": "all",
              "VolumeRate": 1
            }
          ]
        },
        "BlendList": {
          "LocationId": [
            "RV01"
          ]
        },
        "LayoutId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
        "MixList": {
          "LocationId": [
            "RV01"
          ]
        },
        "VideoLayers": {
          "VideoLayer": [
            {
              "FillMode": "fit",
              "FixedDelayDuration": 20,
              "HeightNormalized": 0.5,
              "PositionNormalizeds": {
                "Position": [
                  0
                ]
              },
              "PositionRefer": "topLeft",
              "WidthNormalized": 0.5
            }
          ]
        }
      }
    ]
  },
  "RequestId": "3be7ade8-d907-483c-b24a-0dad45****",
  "Total": 3
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.