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

Adiciona um componente a um estúdio de produção.

Descrição da operação

Antes de chamar esta operação, crie um estúdio de produção e revise sua lista de layouts. Esta operação adiciona componentes como imagens, textos e legendas. Para obter mais informações sobre como criar um estúdio de produção usando uma chamada de API, consulte Criar um estúdio de produção.

Limite de QPS

O limite de consultas por segundo (QPS) para um único usuário é 10. Se você exceder esse limite, as chamadas de API serão limitadas. Isso pode afetar seus negócios. Planeje suas chamadas de acordo.

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

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. Se você criar o estúdio de produção chamando a operação CreateCaster, encontre o ID no parâmetro CasterId da resposta. Se você criar o estúdio de produção no console do Live, acesse a página Console do 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.	LIVEPRODUCER_POST-cn-0pp1czt****
ComponentName	string	Não	O nome do componente. O valor padrão é o ID do componente.	text01
LocationId	string	Sim	Especifica a posição do componente. Cada posição pode conter apenas um componente. O formato deve ser de RC01 a RC99. Nota Se o tipo de componente for legenda, este parâmetro especifica a localização da fonte de vídeo referenciada.	RC01
ComponentType	string	Sim	O tipo de componente. Valores válidos: text: Um componente de texto. Se você definir este parâmetro como text, também deverá definir o parâmetro TextLayerContent. image: Um componente de imagem. Se você definir este parâmetro como image, também deverá definir o parâmetro ImageLayerContent. caption: Um componente de legenda. Se você definir este parâmetro como caption, também deverá definir o parâmetro CaptionLayerContent.	text
Effect	string	Não	O efeito de exibição do componente. Valores válidos: none (padrão): Sem efeito. animateH: Rola horizontalmente. animateV: Rola verticalmente.	animateH
ComponentLayer	string	Sim	O tamanho, o layout e outras informações sobre a camada do componente. Os elementos são descritos da seguinte forma: HeightNormalized: A altura normalizada. WidthNormalized: A largura normalizada. PositionNormalized: A posição normalizada do elemento da camada. PositionRefer: As coordenadas de referência para a posição do elemento. O valor é uma string formatada em JSON. Os nomes dos parâmetros devem estar em UpperCamelCase.	{"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]}
LayerOrder	string	Não	A ordem da camada do componente. cover: O componente está em primeiro plano. background: O componente está em segundo plano.	cover
TextLayerContent	string	Não	As propriedades do elemento da camada. As propriedades são descritas da seguinte forma: Importante Este parâmetro é obrigatório apenas quando ComponentType é definido como text. SizeNormalized: O tamanho da fonte normalizado. Este valor é calculado como tamanho da fonte / altura de saída. O valor deve estar no intervalo `[0,1]`. Se o tamanho da fonte calculado a partir do valor normalizado for maior que 1024, o tamanho da fonte será definido como 1024. BorderWidthNormalized: A largura normalizada da borda do texto. Este valor é calculado com base no tamanho da fonte: BorderWidth / FontSize. O valor deve estar no intervalo `[0,1]`. Se a largura calculada a partir do valor normalizado for maior que 16, a largura será definida como 16. O valor padrão é 0. FontName: O nome da fonte. Para valores válidos, consulte Fontes do estúdio de produção. A fonte padrão é KaiTi. BorderColor: A cor da borda do texto. O valor deve ser um código de cor hexadecimal que varia de 0x000000 a 0xffffff. O valor padrão é uma string vazia (""), o que indica que nenhuma cor de borda está definida. Text: O conteúdo do texto. O valor padrão é uma string vazia (""). Color: A cor do texto. O valor padrão é 0xff0000, que representa vermelho. O valor deve ser uma string formatada em JSON. Os nomes dos parâmetros devem estar em UpperCamelCase.	{"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"}
ImageLayerContent	string	Não	As propriedades do elemento da camada. As propriedades são descritas da seguinte forma: Importante Este parâmetro é obrigatório quando ComponentType é definido como image. MaterialId: O ID do recurso de mídia. O nome que você especifica ao carregar um recurso de mídia é usado como o ID do recurso de mídia. O valor deve ser uma string formatada em JSON. Os nomes dos parâmetros devem estar em UpperCamelCase.	{"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d****"}
CaptionLayerContent	string	Não	As propriedades do elemento da camada. As propriedades são descritas da seguinte forma: Importante Este parâmetro é obrigatório quando ComponentType é definido como caption. SizeNormalized: O tamanho da fonte normalizado. Este valor é calculado como tamanho da fonte / altura de saída. O valor deve estar no intervalo `[0,1]` e ser preciso até duas casas decimais. Se o tamanho da fonte calculado a partir do valor normalizado for maior que 1024, o tamanho da fonte será definido como 1024. BorderWidthNormalized: A largura normalizada da borda do texto. Este valor é calculado com base no tamanho da fonte: BorderWidth / FontSize. O valor deve estar no intervalo `[0,1]` e ser preciso até duas casas decimais. Se a largura calculada a partir do valor normalizado for maior que 16, a largura será definida como 16. O valor padrão é 0. FontName: O nome da fonte. Para valores válidos, consulte Fontes do estúdio de produção. A fonte padrão é KaiTi. BorderColor: A cor da borda do texto. O valor deve ser um código de cor hexadecimal que varia de 0x000000 a 0xffffff. O valor padrão é uma string vazia (""), o que indica que nenhuma cor de borda está definida. LocationId: O ID do canal da fonte de tradução. SourceLan: O idioma de áudio original da fonte de vídeo. Valores válidos: en (inglês), cn (chinês), es (espanhol) e ru (russo). O valor padrão é cn. TargetLan: O idioma de áudio de destino para a fonte de vídeo. Se você não definir este parâmetro, apenas o reconhecimento de fala será executado. Se você definir este parâmetro, o áudio será traduzido. Valores válidos: en (inglês), cn (chinês), es (espanhol) e ru (russo). ShowSourceLan: Especifica se o idioma de origem deve ser exibido. Valores válidos: true e false. O valor padrão é false. Truncation: Especifica se as legendas podem ser truncadas. Valores válidos: true e false. O valor padrão é false. SourceLanPerLineWordCount: O número máximo de palavras por linha para as legendas no idioma de origem. O valor padrão é 20. TargetLanPerLineWordCount: O número máximo de palavras por linha para as legendas no idioma de destino. O valor padrão é 20. SourceLanReservePages: O número de linhas a serem reservadas para as legendas no idioma de origem. Este parâmetro entra em vigor apenas quando Truncation é definido como true. O valor padrão é 2. TargetLanReservePages: O número de linhas a serem reservadas para as legendas no idioma de destino. Este parâmetro entra em vigor apenas quando Truncation é definido como true. O valor padrão é 2. O valor deve ser uma string formatada em JSON. Os nomes dos parâmetros devem estar em UpperCamelCase.	{"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"}
HtmlLayerContent	string	Não	A configuração do componente H5.	{"htmlUrl":http://caster.example.com}

Fontes do estúdio de produção

Fonte	Valor de FontName
KaiTi	KaiTi
Alibaba PuHuiTi - Regular	AlibabaPuHuiTi-Regular
Alibaba PuHuiTi - Bold	AlibabaPuHuiTi-Bold
Alibaba PuHuiTi - Light	AlibabaPuHuiTi-Light
Source Han Sans - Regular	NotoSansHans-Regular
Source Han Sans - Bold	NotoSansHans-Bold
Source Han Sans - Light	NotoSansHans-Light

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
ComponentId	string	O ID do componente. Use este ID para consultar, modificar ou excluir o componente.	21926b36-7dd2-4fde-ae25-51b5bc8e****
RequestId	string	O ID da solicitação.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Exemplos

Resposta de sucesso

JSON formato

{
  "ComponentId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

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.	The userId passed in is invalid, please check.
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	MissingParameter	%s.	Missing parameter
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidPositionNormalized.Malformed	%s, please check and try again later.	The parameter PositionNormalized is invalid, please check and try again.
400	DuplicateLocationID	%s, please check and try again later.	The parameter LocationID duplicate. 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.
404	CanvasNotExist	%s, please check and try again later.	Canvas 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.