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

Descrição da operação

Você pode chamar esta operação para adicionar configurações de layout para um estúdio de produção virtual. Esta operação suporta layouts comuns e de estúdio.

Limite de QPS

O limite de consultas por segundo (QPS) para esta operação é de 10 por usuário. Se você exceder esse limite, suas chamadas de API serão limitadas. Isso pode afetar seus negócios. Recomendamos que você chame esta operação 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:AddStudioLayout

create

*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. Importante Crie um estúdio de produção virtual com antecedência. Você pode criar um estúdio de produção no console ou chamando a operação de API CreateCaster. O estúdio de produção deve ser um estúdio de produção virtual. Se você chamar a operação de API CreateCaster para criar um estúdio de produção, use o valor CasterId retornado. Se você criar um estúdio de produção no console do ApsaraVideo Live, acesse a página Console do ApsaraVideo Live > Estúdio de Produção > Estúdio de Produção em Nuvem. O nome do estúdio de produção na lista é o seu ID. Nota O nome do estúdio de produção na lista na página Estúdio de Produção em Nuvem é o ID do estúdio de produção.	a2b8e671-2fe5-4642-a2ec-bf93880e****
LayoutName	string	Sim	O nome do layout do estúdio.	Test layout
LayoutType	string	Sim	O tipo de layout do estúdio. Valores válidos: common: Um layout comum. Se você definir LayoutType como common, também deverá especificar CommonConfig. studio: Um layout de estúdio. Se você definir LayoutType como studio, também deverá especificar BgImageConfig e ScreenInputConfigList. O parâmetro MediaInputConfigList é opcional.	studio
CommonConfig	string	Não	A configuração do layout comum. O valor é uma string JSON. Para mais informações, consulte CommonConfig. Importante Este parâmetro é obrigatório apenas quando você define LayoutType como common.	{"ChannelId":"RV01" }
BgImageConfig	string	Não	A configuração do recurso de plano de fundo. O valor é uma string JSON. Para mais informações, consulte BgImageConfig. Importante Este parâmetro é obrigatório apenas quando você define LayoutType como studio.	{ "Id":"k12kj31**", "MaterialId":"f080575eb5f4427684fc0715159a**" }
ScreenInputConfigList	string	Não	As configurações para a entrada de chroma key. O valor é uma string JSON. Para mais informações, consulte ScreenInputConfig. Importante Este parâmetro é obrigatório apenas quando você define LayoutType como studio.	[ { "Index":"1", "ChannelId":"RV01", "Color":"green", "PositionX":"0.1", "PositionY":"0.2", "HeightNormalized":"0.4" } ]
MediaInputConfigList	string	Não	As configurações para o recurso de entrada multimídia. O valor é uma string JSON. Para mais informações, consulte MediaInputConfig. Importante Este parâmetro é válido e opcional apenas quando você define LayoutType como studio.	[ { "Id":"k12kj31**", "Index":"1", "ChannelId":"RV01", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.4", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" }, { "Id":"k12kj31", "Index":"2", "ImageMaterialId":"lkajsdfsa8fd89asd8**", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.6", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" } ]
LayerOrderConfigList	string	Não	As configurações de ordem das camadas. O valor é uma string JSON. Para mais informações, consulte LayerOrderConfig. Você pode classificar materiais de plano de fundo e materiais multimídia. Camadas de chroma key não são suportadas. Quanto mais cedo um material aparecer na lista, mais baixa será sua camada.	[ { "Type":"media", "Id":"k12kj31**" }, { "Type":"media", "Id":"k12kj31**" } ]

CommonConfig

Nome	Tipo	Exemplo	Descrição
ChannelId	String	RV01	O ID do canal ao qual o recurso de vídeo está anexado.

BgImageConfig

Nota

Especifique apenas um entre ImageUrl ou MaterialId.

Nome	Tipo	Exemplo	Descrição
Id	String	k12kj31****	O ID exclusivo do material de plano de fundo.
ImageUrl	String	http://aliyundoc.com	A URL do material.
MaterialId	String	f080575eb5f4427684fc0715159a****	O ID do material de vídeo sob demanda (VOD).

ScreenInputConfig

Nome	Tipo	Exemplo	Descrição
Index	Integer	1	O número da fonte de chroma key. Este parâmetro é para exibição no frontend e não possui função lógica. Deve ser um número inteiro positivo maior que 0.
ChannelId	String	RV01	O ID do canal ao qual o recurso de vídeo está anexado.
Color	String	green	A cor para chroma key. Valores válidos: blue: Plano de fundo de tela azul. green: Plano de fundo de tela verde. auto: Detecção automática. complex: Chroma key de cena real.
PositionX	Float	0.1	A coordenada x. O valor deve estar no intervalo [0, 1]. O canto superior esquerdo é o ponto de referência para a posição do material.
PositionY	Float	0.2	A coordenada y. O valor deve estar no intervalo [0, 1]. O canto superior esquerdo é o ponto de referência para a posição do material.
HeightNormalized	Float	0.4	A altura normalizada. Esta é a proporção da altura do retrato recortado em relação à altura do plano de fundo. O valor deve estar no intervalo [0, 1].

MediaInputConfig

Se o material multimídia for uma fonte de vídeo, especifique ChannelId.
Se o material multimídia for uma imagem, especifique ImageMaterialId.
ChannelId e ImageMaterialId são mutuamente exclusivos. Especifique apenas um.

Nome	Tipo	Exemplo	Descrição
Id	String	k12kj31****	O ID exclusivo do material multimídia.
Index	Integer	1	O número do material multimídia. Este parâmetro é para exibição no frontend e não possui função lógica. Deve ser um número inteiro positivo maior que 0.
ChannelId	String	RV01	O ID do canal ao qual o recurso de vídeo está anexado.
ImageMaterialId	String	lkajsdfsa8fd89asd8****	O ID do material de imagem VOD.
FillMode	String	none	O tipo de preenchimento. Defina como none.
PositionRefer	String	topLeft	O ponto de referência para a posição do material. Defina como topLeft. Isso indica que o canto superior esquerdo é o ponto de referência.
WidthNormalized	Float	0.4	A largura normalizada do material. Esta é a proporção da largura do material em relação à largura do plano de fundo. O valor deve estar no intervalo [0, 1].
HeightNormalized	Float	0.4	A altura normalizada do material. Esta é a proporção da altura do material em relação à altura do plano de fundo. O valor deve estar no intervalo [0, 1].
PositionNormalized	Float	[0.1, 0.2]	A posição normalizada da área de preenchimento do material [x, y]. Os valores de x e y devem estar no intervalo [0, 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.

LayerOrderConfig

Nome	Tipo	Exemplo	Descrição
Type	String	media	O tipo de configuração do recurso. background: Um material de plano de fundo. media: Um material multimídia.
Id	String	k12kj31****	O ID exclusivo do recurso.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
LayoutId	string	O ID do layout. Use este ID para excluir, modificar ou consultar um layout de estúdio de produção virtual.	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	O ID da solicitação.	5c6a2a0d-f228-4a64-af62-20e91b96****

Exemplos

Resposta de sucesso

JSON formato

{
  "LayoutId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParameter	%s.	Missing parameter
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	InvalidPositionNormalized.Malformed	%s, please check and try again later.	The parameter PositionNormalized is invalid, please check and try again.
400	InvalidHeightOrWidthNormalized	%s, please check and try again later.	HeightNormalized or WidthNormalized parameters are 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.