MediaInfo

This class encapsulates and extends the ROS resource type ALIYUN::ICE::MediaInfo.

Initializers

import ros_cdk_ice
ros_cdk_ice.MediaInfo(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No 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.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

input_url^Required

• 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_type^Optional

• 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_id^Optional

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

Property cateId: The category ID.

---

cover_url^Optional

• 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.

---

description^Optional

• 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_tags^Optional

• 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_type^Optional

• 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 .

---

overwrite^Optional

• 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_id^Optional

• 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_config^Optional

• 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_id^Optional

• 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.

---

title^Optional

• 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_data^Optional

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

Property userData: The user data.

You can specify a custom callback URL.

---

workflow_id^Optional

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

Property workflowId: The workflow ID.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_ice
ros_cdk_ice.MediaInfo.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_media_id	ros_cdk_core.IResolvable	Attribute MediaId: The ID of the media asset in IMS.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_media_id^Required

attr_media_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute MediaId: The ID of the media asset in IMS.

---