Skip to content

MediaInfoProps

Properties for defining a MediaInfo.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ice-mediainfo

Initializer 

import ros_cdk_ice
ros_cdk_ice.MediaInfoProps(
  input_url: typing.Union[str, IResolvable],
  business_type: typing.Union[str, IResolvable] = None,
  cate_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  cover_url: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  media_tags: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  media_type: typing.Union[str, IResolvable] = None,
  overwrite: typing.Union[bool, IResolvable] = None,
  reference_id: typing.Union[str, IResolvable] = None,
  register_config: typing.Union[str, IResolvable] = None,
  smart_tag_template_id: typing.Union[str, IResolvable] = None,
  title: typing.Union[str, IResolvable] = None,
  user_data: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  workflow_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
input_url typing.Union[str, ros_cdk_core.IResolvable] Property inputUrl: The URL of the media asset in another service.
business_type typing.Union[str, ros_cdk_core.IResolvable] Property businessType: The business type of the media asset.
cate_id typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property cateId: The category ID.
cover_url typing.Union[str, ros_cdk_core.IResolvable] Property coverUrl: The thumbnail URL of the media asset.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the media asset.
media_tags typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property mediaTags: The tags of the media asset.
media_type typing.Union[str, ros_cdk_core.IResolvable] Property mediaType: The type of the media asset.
overwrite typing.Union[bool, ros_cdk_core.IResolvable] Property overwrite: Specifies whether to overwrite the media asset that has been registered by using the same URL.
reference_id typing.Union[str, ros_cdk_core.IResolvable] Property referenceId: The custom ID.
register_config typing.Union[str, ros_cdk_core.IResolvable] Property registerConfig: The registration configurations.
smart_tag_template_id typing.Union[str, ros_cdk_core.IResolvable] Property smartTagTemplateId: The ID of the smart tagging template.
title typing.Union[str, ros_cdk_core.IResolvable] Property title: The title.
user_data typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property userData: The user data.
workflow_id typing.Union[str, ros_cdk_core.IResolvable] Property workflowId: The workflow ID.

input_urlRequired 

input_url: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property inputUrl: The URL of the media asset in another service.

The URL is associated with the ID of the media asset in IMS. The URL cannot be modified once registered. The following types of URLs are supported: OSS URL in one of the following formats: http(s)://example-bucket.oss-cn-shanghai.aliyuncs.com/example.mp4 oss://example-bucket/example.mp4: In this format, it is considered by default that the region of the OSS bucket in which the media asset resides is the same as the region in which IMS is activated. URL of an ApsaraVideo VOD media asset vod://20b48fb04483915d4f2cd8ac*

business_typeOptional 

business_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property businessType: The business type of the media asset.

Valid values: subtitles watermark opening ending general

cate_idOptional 

cate_id: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property cateId: The category ID.

cover_urlOptional 

cover_url: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property coverUrl: The thumbnail URL of the media asset.

The value can be up to 128 bytes in length. The value must be encoded in UTF-8.

descriptionOptional 

description: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the media asset.

The value can be up to 1,024 bytes in length. The value must be encoded in UTF-8.

media_tagsOptional 

media_tags: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property mediaTags: The tags of the media asset.

Up to 16 tags are supported. Separate multiple tags with commas (,). Each tag can be up to 32 bytes in length. The value must be encoded in UTF-8.

media_typeOptional 

media_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property mediaType: The type of the media asset.

Valid values: image video audio text We recommend that you specify this parameter based on your business requirements. If you set InputURL to an OSS URL, the media asset type can be automatically determined based on the file name extension. For more information .

overwriteOptional 

overwrite: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property overwrite: Specifies whether to overwrite the media asset that has been registered by using the same URL.

Default value: false. Valid values:

  • true: If a media asset has been registered by using the same URL, the original media asset is deleted and the new media asset is registered.
  • false: If a media asset has been registered by using the same URL, the new media asset is not registered. A URL cannot be used to register multiple media assets.

reference_idOptional 

reference_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property referenceId: The custom ID.

The ID can be 6 to 64 characters in length and can contain only letters, digits, hyphens (-), and underscores (_). Make sure that the ID is unique among users.

register_configOptional 

register_config: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property registerConfig: The registration configurations.

By default, a sprite is generated for the media asset. You can set NeedSprite to false to disable automatic sprite generation. By default, a snapshot is generated for the media asset. You can set NeedSnapshot to false to disable automatic snapshot generation.

smart_tag_template_idOptional 

smart_tag_template_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property smartTagTemplateId: The ID of the smart tagging template.

Valid values: S00000101-300080: the system template that supports natural language processing (NLP) for content recognition. S00000103-000001: the system template that supports NLP for content recognition and all tagging capabilities. S00000103-000002: the system template that supports all tagging capabilities but does not support NLP for content recognition. After you configure this parameter, a smart tag analysis task is automatically initiated after the media asset is registered. For more information about the billable items.

titleOptional 

title: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property title: The title.

If you do not specify this parameter, a default title is automatically generated based on the date. The value can be up to 128 bytes in length. The value must be encoded in UTF-8.

user_dataOptional 

user_data: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property userData: The user data.

You can specify a custom callback URL.

workflow_idOptional 

workflow_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property workflowId: The workflow ID.