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

Descrição da operação

Você pode chamar esta operação para modificar o layout de um estúdio de produção. Ao modificar as configurações de layout, passe apenas os parâmetros que deseja alterar.

Limite de QPS

O limite de QPS para esta operação é de 10 chamadas por segundo para cada usuário. Se você exceder o limite, as 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:ModifyStudioLayout

update

*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 O estúdio de produção deve ser criado com antecedência e deve ser do tipo estúdio virtual. Se você criar um estúdio de produção chamando a operação CreateCaster, use o valor CasterId retornado na resposta. 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 para visualizar o ID. 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.	a2b8e671-2fe5-4642-a2ec-bf93880e****
LayoutId	string	Sim	O ID do layout. Se você adicionar um layout para um estúdio de produção chamando a operação AddStudioLayout, use o valor LayoutId retornado na resposta.	445409ec-7eaa-461d-8f29-4bec2eb9****
LayoutName	string	Não	O nome do layout do estúdio de produção.	Test layout
CommonConfig	string	Não	A configuração do layout comum. Este parâmetro é uma string JSON. Para mais informações, consulte CommonConfig. Importante Este parâmetro é obrigatório apenas quando LayoutType está definido como common.	{ "ChannelId":"RV01" }
BgImageConfig	string	Não	A configuração do recurso de plano de fundo. Este parâmetro é uma string JSON. Para mais informações, consulte BgImageConfig. Importante Este parâmetro é obrigatório apenas quando LayoutType está definido como studio.	{ "Id":"k12kj31**", "MaterialId":"f080575eb5f4427684fc0715159a**" }
ScreenInputConfigList	string	Não	As configurações para a entrada de chroma key. Este parâmetro é uma string JSON. Para mais informações, consulte ScreenInputConfig. Importante Este parâmetro é obrigatório apenas quando LayoutType está definido 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. Este parâmetro é uma string JSON. Para mais informações, consulte MediaInputConfig. Importante Este parâmetro é válido e opcional apenas quando LayoutType está definido 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. Este parâmetro é uma string JSON. Para mais informações, consulte layerOrderConfig. Você pode ordenar materiais de plano de fundo e multimídia. Camadas de chroma key não são suportadas. Quanto mais cedo um item 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

ImageUrl e MaterialId são mutuamente exclusivos.

ScreenInputConfig

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

MediaInputConfig

Para uma fonte de vídeo, especifique ChannelId.
Para uma imagem, especifique ImageMaterialId.
ChannelId e ImageMaterialId são mutuamente exclusivos. Você pode especificar apenas um.

Nome	Tipo	Exemplo	Descrição
Id	String	k12kj31****	O ID exclusivo do material multimídia.
Index	Integer	1	O ID do material multimídia. Este ID é usado para exibição no frontend e não possui função lógica. Deve ser um número inteiro positivo (>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 do VOD.
FillMode	String	none	O tipo de preenchimento. Defina este parâmetro como none.
PositionRefer	String	topLeft	A coordenada de referência para a posição do material. Defina este parâmetro como topLeft para usar o canto superior esquerdo como ponto de referência.
WidthNormalized	Float	0.4	A largura normalizada do material. Esta é a proporção da largura do material em relação ao plano de fundo. O valor deve estar entre 0 e 1, inclusive.
HeightNormalized	Float	0.4	A altura normalizada do material. Esta é a proporção da altura do material em relação ao plano de fundo. O valor deve estar entre 0 e 1, inclusive.
PositionNormalized	Float	[0.1, 0.2]	A posição normalizada [x,y] da área de preenchimento do material. Os valores de x e y devem estar entre 0 e 1, inclusive. Por exemplo, um valor de [0.1, 0.2] representa um deslocamento horizontal de 10% e um deslocamento vertical de 20% a partir do canto superior esquerdo.

layerOrderConfig

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	5c6a2a0d-f228-4a64-af62-20e91b9676b3

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3"
}

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	InvalidLayout.NotFound	%s, please check and try again later.	LayoutId does not exist, please check and try again.
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.