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

Consulta a lista de componentes de um estúdio de produção.

Descrição da operação

Chame a operação AddCasterComponent para adicionar componentes a um estúdio de produção. Em seguida, você pode chamar esta operação para consultar a lista de componentes.

Limite de QPS

O limite de consultas por segundo (QPS) para um único usuário é 15. Se você exceder o limite, as chamadas de API serão limitadas. Isso pode afetar seus negócios, portanto, certifique-se de chamar esta operação dentro do limite.

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

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, obtenha o ID do parâmetro CasterId na resposta. Se você criou o estúdio de produção no console LIVE, acesse a página Cloud Production Studio escolhendo Console LIVE > Estúdio de Produção > Estúdio de Produção em Nuvem. Nota O nome do estúdio de produção na lista na página Cloud Production Studio é o ID do estúdio de produção.	LIVEPRODUCER_POST-cn-0pp1czt****
ComponentId	string	Não	O ID do componente. Se você adicionou o componente chamando a operação AddCasterComponent, obtenha o ID do parâmetro ComponentId na resposta.	21926b36-7dd2-4fde-ae25-51b5bc8e****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Components	object
Component	array<object>	A lista de componentes.
	array<object>
CaptionLayerContent	object	The properties of the caption element.
BorderColor	string	The color of the text border. Valid values: 0x000000 to 0xffffff. The default value is an empty string (""), which means this parameter is not used.	0x000000
BorderWidthNormalized	number	The normalized width of the text border. The value is calculated based on the font size: BorderWidth/FontSize. If the calculated value exceeds 16, the value 16 is used. Default value: 0.	0
Color	string	The color of the text. Valid values: 0x000000 to 0xffffff.	0x000000
FontName	string	The font. The value must be a preset value. Valid values: KaiTi: KaiTi AlibabaPuHuiTi-Regular: Alibaba PuHuiTi Regular AlibabaPuHuiTi-Bold: Alibaba PuHuiTi Bold NAlibabaPuHuiTi-Light: Alibaba PuHuiTi Light NotoSansHans-Regular: Noto Sans CJK Regular NotoSansHans-Bold: Noto Sans CJK Bold NotoSansHans-Light: Noto Sans CJK Light Default value: KaiTi.	KaiTi
LineSpaceNormalized	number	The line spacing. This parameter specifies the space between two lines of text. Default value: 0.	0
LocationId	string	If the component type is caption, this parameter specifies the location of the referenced video source (the channel ID).	RV01
PtsOffset	integer	The value used to correct the drift between the presentation timestamp (PTS) of the caption and the PTS of the audio. Valid values: -10000 to +10000. Default value: 0.	0
ShowSourceLan	boolean	Specifies whether to display the source language. Valid values: true: The source language is displayed. false (default): The source language is not displayed.	false
SizeNormalized	number	The normalized font size. The font size is set to `[font_size,output_height]`. If the calculated font size is greater than 1024, the value 1024 is used. The default value is -1, which means this parameter is not used.	0.1
SourceLan	string	The source language of the video source audio. Valid values: en: English cn (default): Chinese es: Spanish ru: Russian	cn
TargetLan	string	The target language of the video source audio. Valid values: en: English cn (default): Chinese es: Spanish ru: Russian	cn
WordCountPerLine	integer	The maximum number of characters to display per line.	15
WordSpaceNormalized	number	The character spacing. This parameter specifies the space between two characters. Default value: 0.	0
WordsCount	integer	The number of characters to display. You can adjust this value along with the font size. Valid values: 10 to 50. Default value: 35.	35
ComponentId	string	The component ID.	72d2ec7a-4cd7-4a01-974b-7cd53947****
ComponentLayer	object	The size, layout, and other information of the component layer.
HeightNormalized	number	The normalized height of the layer element. The width of the element is scaled proportionally based on this height. The default value is 0, which means the element is displayed in its original size.	0.5
PositionNormalizeds	object
Position	array	The normalized coordinates of the layer element, in the format `[x,y]`. Default value: `[0,0]`. Nota The values of x and y must be normalized.
	number	The value.	0.3
PositionRefer	string	The reference point for the element's position. Valid values: topLeft (default): The top-left corner. topRight: The top-right corner. bottomLeft: The bottom-left corner. bottomRight: The bottom-right corner.	topLeft
Transparency	integer	The transparency of the layer. Valid values: 0 to 255. A value of 0 indicates that the layer is fully transparent. A value of 255 (default) indicates that the layer is fully opaque.	200
WidthNormalized	number	The normalized width of the layer element. The height of the element is scaled proportionally based on this width. The default value is 0, which means the element is displayed in its original size. Nota This parameter conflicts with HeightNormalized. If both are set, only HeightNormalized takes effect. If you set only one, the value set later overrides the previous one.	0.5
ComponentName	string	The component name. The default value is the component ID.	component_name
ComponentType	string	The component type. Valid values: text: Text component. image: Image component. caption: Translated caption component.	text
Effect	string	The display effect of the component. Valid values: none: No effect. animateH: Horizontal scroll. animateV: Vertical scroll.	animateV
ImageLayerContent	object	The properties of the image element.
MaterialId	string	The ID of the media asset.	6cf724c6ebfd4a59b5b3cec6f10d****
LocationId	string	The position of the component. You can set only one component for each position. The format must be "RC01" to "RC12".	RC01
TextLayerContent	object	The properties of the text element.
BorderColor	string	The color of the text border. Valid values: 0x000000 to 0xffffff. The default value is an empty string (""), which means this parameter is not used.	0x000000
BorderWidthNormalized	number	The normalized width of the text border. The value is calculated based on the font size: BorderWidth/FontSize. If the calculated value exceeds 16, the value 16 is used. Default value: 0.	0
Color	string	The color of the text. Valid values: 0x000000 to 0xffffff.	0xff0000
FontName	string	The font. The value must be a preset value. Valid values: KaiTi: KaiTi AlibabaPuHuiTi-Regular: Alibaba PuHuiTi Regular AlibabaPuHuiTi-Bold: Alibaba PuHuiTi Bold NAlibabaPuHuiTi-Light: Alibaba PuHuiTi Light NotoSansHans-Regular: Noto Sans CJK Regular NotoSansHans-Bold: Noto Sans CJK Bold NotoSansHans-Light: Noto Sans CJK Light Default value: KaiTi.	KaiTi
SizeNormalized	number	The normalized font size. The size is set to font_size/output_height. If the calculated font size is greater than 1024, the value 1024 is used. The default value is -1, which means this parameter is not used.	16
Text	string	The text content.	hello world
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

{
  "Components": {
    "Component": [
      {
        "CaptionLayerContent": {
          "BorderColor": "0x000000",
          "BorderWidthNormalized": 0,
          "Color": "0x000000",
          "FontName": "KaiTi",
          "LineSpaceNormalized": 0,
          "LocationId": "RV01",
          "PtsOffset": 0,
          "ShowSourceLan": false,
          "SizeNormalized": 0.1,
          "SourceLan": "cn",
          "TargetLan": "cn",
          "WordCountPerLine": 15,
          "WordSpaceNormalized": 0,
          "WordsCount": 35
        },
        "ComponentId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
        "ComponentLayer": {
          "HeightNormalized": 0.5,
          "PositionNormalizeds": {
            "Position": [
              0.3
            ]
          },
          "PositionRefer": "topLeft",
          "Transparency": 200,
          "WidthNormalized": 0.5
        },
        "ComponentName": "component_name",
        "ComponentType": "text",
        "Effect": "animateV",
        "ImageLayerContent": {
          "MaterialId": "6cf724c6ebfd4a59b5b3cec6f10d****"
        },
        "LocationId": "RC01",
        "TextLayerContent": {
          "BorderColor": "0x000000",
          "BorderWidthNormalized": 0,
          "Color": "0xff0000",
          "FontName": "KaiTi",
          "SizeNormalized": 16,
          "Text": "hello world"
        }
      }
    ]
  },
  "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.