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

Obtém as configurações de layout de um estúdio virtual.

Descrição da operação

Antes de chamar esta operação, adicione configurações de layout para um estúdio virtual chamando a operação AddStudioLayout. Em seguida, chame esta operação para obter as configurações de layout do estúdio virtual.

Limite de QPS

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

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

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, verifique o valor do parâmetro CasterId retornado pela operação CreateCaster. Se você criou o estúdio de produção no console ApsaraVideo Live, vá para Console ApsaraVideo Live > Estúdio de Produção > Estúdio de Produção em Nuvem para visualizar o ID. Nota O nome do estúdio de produção na lista de estúdios de produção na página Estúdio de Produção em Nuvem é o ID do estúdio de produção. Apenas estúdios de produção do tipo estúdio virtual (NormType=4) são suportados. Se você passar um ID de estúdio de produção de outro tipo, InvalidCaster.NotFound será retornado. Chame DescribeCasters e filtre por NormType=4 para obter o ID do estúdio de produção do estúdio virtual.	5c6a2a0d-f228-4a64-af62-20e91b96****
LayoutId	string	Não	O ID do layout. Separe vários IDs de layout com vírgulas (,). Se este parâmetro não for especificado, todos os layouts sob o estúdio de produção serão retornados. Se você adicionou configurações de layout de estúdio virtual chamando a operação AddStudioLayout, verifique o valor do parâmetro LayoutId retornado pela operação AddStudioLayout.	445409ec-7eaa-461d-8f29-4bec2eb9****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações do layout.
RequestId	string	O ID da solicitação.	5c6a2a0d-f228-4a64-af62-20e91b9676b3
StudioLayouts	array<object>	As informações do layout.
	array<object>	As informações do layout.
BgImageConfig	object	A configuração do recurso de fundo.
Id	string	O ID exclusivo do material de fundo.	k12kj31****
ImageUrl	string	A URL do material.	http://example.org
LocationId	string	O ID da posição.	RV01
MaterialId	string	O ID do material de vídeo sob demanda (VOD).	asdfas9df89asd8f9****
CommonConfig	object	As informações comuns do layout. Este campo é retornado quando o layout é um layout comum.
ChannelId	string	O ID do canal ao qual o recurso de vídeo está vinculado.	RV01
VideoResourceId	string	O ID do recurso de vídeo.	asdfasdfasdfasdfa****
LayerOrderConfigList	array<object>	A configuração da ordem das camadas.
	object	A configuração da ordem das camadas.
Id	string	O ID exclusivo do recurso.	k12kj31****
Type	string	O tipo da configuração do recurso. Valores válidos: background: material de fundo. media: material multimídia.	media
LayoutId	string	O ID do layout do estúdio.	445409ec-7eaa-461d-8f29-4bec2eb9****
LayoutName	string	O nome do layout do estúdio.	测试布局
LayoutType	string	O tipo do layout do estúdio. Valores válidos: common: layout comum. studio: layout do estúdio.	studio
MediaInputConfigList	array<object>	A configuração do recurso de entrada multimídia.
	object	A configuração da fonte de entrada multimídia.
ChannelId	string	O ID do canal ao qual o recurso de vídeo está vinculado.	RV01
FillMode	string	O modo de preenchimento. O valor padrão é none.	none
HeightNormalized	number	A altura normalizada do material. Esta é a proporção entre a altura do material e a altura do fundo. Valores válidos: 0 a 1.	0.4
Id	string	O ID exclusivo do material multimídia.	k12kj31****
ImageMaterialId	string	O ID do material de imagem VOD.	lkajsdfsa8fd89asd8****
Index	integer	O índice do material multimídia. Este parâmetro é para exibição no frontend e não possui função lógica.	1
PositionNormalized	array	As coordenadas normalizadas da área de preenchimento do material, no formato [x,y]. Os valores de x e y variam de 0 a 1. Por exemplo, [0.1,0.2] indica um deslocamento horizontal de 10% e um deslocamento vertical de 20% a partir do canto superior esquerdo.
	number	A coordenada normalizada da área de preenchimento do material, no formato `[x,y]`. Os valores de x e y variam de 0 a 1. Por exemplo, `[0.1,0.2]` indica um deslocamento horizontal de 10% e um deslocamento vertical de 20% a partir do canto superior esquerdo.	0.1
PositionRefer	string	O ponto de referência para a posição do material. O valor padrão é topLeft, que indica que o canto superior esquerdo é o ponto de referência.	topLeft
VideoResourceId	string	O ID do recurso de vídeo.	asdfasdfasdfasdfa****
WidthNormalized	number	A largura normalizada do material. Esta é a proporção entre a largura do material e a largura do fundo. Valores válidos: 0 a 1.	0.4
ScreenInputConfigList	array<object>	A configuração de entrada de chroma key.
	array<object>	A configuração de entrada de chroma key.
AudioConfig	object	A configuração de áudio.
ValidChannel	string	O canal correspondente.	1
VolumeRate	number	O volume.	1.0
ChannelId	string	O ID do canal ao qual o recurso de vídeo está vinculado.	RV01
Color	string	A cor para chroma keying. Valores válidos: blue: fundo de tela azul. green: fundo de tela verde. auto: detecção automática. complex: recorte de cena real.	green
HeightNormalized	number	A altura normalizada. Esta é a proporção entre a altura do retrato recortado e a altura do fundo. Valores válidos: 0 a 1.	0.4
Id	string	O ID exclusivo do material de origem de chroma key.	k12kj31****
Index	integer	O índice da fonte de chroma key. Este parâmetro é para exibição no frontend e não possui função lógica.	1
OnlyAudio	boolean	Somente áudio.	true
PortraitType	integer	O tipo de retrato. Valores válidos: 0: meio corpo. 1: corpo inteiro.	0
PositionX	string	A coordenada x. Valores válidos: 0 a 1. O canto superior esquerdo é o ponto de referência para a posição do material.	0.1
PositionY	string	A coordenada y. Valores válidos: 0 a 1. O canto superior esquerdo é o ponto de referência para a posição do material.	0.2
VideoResourceId	string	O ID do recurso de vídeo.	asdfasdfasdfasdfa****
Total	integer	O número de layouts.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3",
  "StudioLayouts": [
    {
      "BgImageConfig": {
        "Id": "k12kj31****",
        "ImageUrl": " http://example.org",
        "LocationId": "RV01",
        "MaterialId": "asdfas9df89asd8f9****"
      },
      "CommonConfig": {
        "ChannelId": "RV01",
        "VideoResourceId": "asdfasdfasdfasdfa****"
      },
      "LayerOrderConfigList": [
        {
          "Id": "k12kj31****",
          "Type": "media"
        }
      ],
      "LayoutId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
      "LayoutName": "测试布局",
      "LayoutType": "studio",
      "MediaInputConfigList": [
        {
          "ChannelId": "RV01",
          "FillMode": "none",
          "HeightNormalized": 0.4,
          "Id": "k12kj31****",
          "ImageMaterialId": "lkajsdfsa8fd89asd8****",
          "Index": 1,
          "PositionNormalized": [
            0.1
          ],
          "PositionRefer": "topLeft",
          "VideoResourceId": "asdfasdfasdfasdfa****",
          "WidthNormalized": 0.4
        }
      ],
      "ScreenInputConfigList": [
        {
          "AudioConfig": {
            "ValidChannel": "1",
            "VolumeRate": 1
          },
          "ChannelId": "RV01",
          "Color": "green",
          "HeightNormalized": 0.4,
          "Id": "k12kj31****",
          "Index": 1,
          "OnlyAudio": true,
          "PortraitType": 0,
          "PositionX": "0.1",
          "PositionY": "0.2",
          "VideoResourceId": "asdfasdfasdfasdfa****"
        }
      ]
    }
  ],
  "Total": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidUserId.Malformed	%s, please check userId.	O userId especificado é inválido. Verifique o valor do parâmetro.
400	InvalidCasterId.Malformed	%s, please check and try again later.	O parâmetro CasterId é inválido. Verifique o parâmetro e tente novamente.
401	IllegalOperation	%s, please check and try again later.	A operação é inválida. Verifique a solicitação e tente novamente.
500	InternalError	%s, please try again later.	Ocorreu um erro interno. Tente novamente mais tarde.
404	InvalidCaster.NotFound	%s, please check and try again later.	O estúdio de produção não existe. Verifique a configuração 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.