MediaInfoProps

Properties for defining a MediaInfo.

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

Initializer

import { MediaInfoProps } from '@alicloud/ros-cdk-ice'
const mediaInfoProps: MediaInfoProps = { ... }

Properties

Name	Type	Description
inputUrl	string | @alicloud/ros-cdk-core.IResolvable	Property inputUrl: The URL of the media asset in another service.
businessType	string | @alicloud/ros-cdk-core.IResolvable	Property businessType: The business type of the media asset.
cateId	number | @alicloud/ros-cdk-core.IResolvable	Property cateId: The category ID.
coverUrl	string | @alicloud/ros-cdk-core.IResolvable	Property coverUrl: The thumbnail URL of the media asset.
description	string | @alicloud/ros-cdk-core.IResolvable	Property description: The description of the media asset.
mediaTags	@alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]	Property mediaTags: The tags of the media asset.
mediaType	string | @alicloud/ros-cdk-core.IResolvable	Property mediaType: The type of the media asset.
overwrite	boolean | @alicloud/ros-cdk-core.IResolvable	Property overwrite: Specifies whether to overwrite the media asset that has been registered by using the same URL.
referenceId	string | @alicloud/ros-cdk-core.IResolvable	Property referenceId: The custom ID.
registerConfig	string | @alicloud/ros-cdk-core.IResolvable	Property registerConfig: The registration configurations.
smartTagTemplateId	string | @alicloud/ros-cdk-core.IResolvable	Property smartTagTemplateId: The ID of the smart tagging template.
title	string | @alicloud/ros-cdk-core.IResolvable	Property title: The title.
userData	@alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}	Property userData: The user data.
workflowId	string | @alicloud/ros-cdk-core.IResolvable	Property workflowId: The workflow ID.

---

inputUrl^Required

public readonly inputUrl: string | IResolvable;

• Type: string | @alicloud/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*

---

businessType^Optional

public readonly businessType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property businessType: The business type of the media asset.

Valid values: subtitles watermark opening ending general

---

cateId^Optional

public readonly cateId: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property cateId: The category ID.

---

coverUrl^Optional

public readonly coverUrl: string | IResolvable;

• Type: string | @alicloud/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

public readonly description: string | IResolvable;

• Type: string | @alicloud/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.

---

mediaTags^Optional

public readonly mediaTags: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/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.

---

mediaType^Optional

public readonly mediaType: string | IResolvable;

• Type: string | @alicloud/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

public readonly overwrite: boolean | IResolvable;

• Type: boolean | @alicloud/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.

---

referenceId^Optional

public readonly referenceId: string | IResolvable;

• Type: string | @alicloud/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.

---

registerConfig^Optional

public readonly registerConfig: string | IResolvable;

• Type: string | @alicloud/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.

---

smartTagTemplateId^Optional

public readonly smartTagTemplateId: string | IResolvable;

• Type: string | @alicloud/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

public readonly title: string | IResolvable;

• Type: string | @alicloud/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.

---

userData^Optional

public readonly userData: IResolvable | {[ key: string ]: any};

• Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property userData: The user data.

You can specify a custom callback URL.

---

workflowId^Optional

public readonly workflowId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property workflowId: The workflow ID.

---