Skip to content

MediaInfo

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

Initializers 

import com.aliyun.ros.cdk.ice.MediaInfo;
MediaInfo.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .inputUrl(java.lang.String)
    .inputUrl(IResolvable)
//  .businessType(java.lang.String)
//  .businessType(IResolvable)
//  .cateId(java.lang.Number)
//  .cateId(IResolvable)
//  .coverUrl(java.lang.String)
//  .coverUrl(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .mediaTags(IResolvable)
//  .mediaTags(java.util.List<java.lang.String)
//  .mediaTags(IResolvable>)
//  .mediaType(java.lang.String)
//  .mediaType(IResolvable)
//  .overwrite(java.lang.Boolean)
//  .overwrite(IResolvable)
//  .referenceId(java.lang.String)
//  .referenceId(IResolvable)
//  .registerConfig(java.lang.String)
//  .registerConfig(IResolvable)
//  .smartTagTemplateId(java.lang.String)
//  .smartTagTemplateId(IResolvable)
//  .title(java.lang.String)
//  .title(IResolvable)
//  .userData(IResolvable)
//  .userData(java.util.Map<java.lang.String, java.lang.Object>)
//  .workflowId(java.lang.String)
//  .workflowId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
inputUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property inputUrl: The URL of the media asset in another service.
businessType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property businessType: The business type of the media asset.
cateId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property cateId: The category ID.
coverUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property coverUrl: The thumbnail URL of the media asset.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the media asset.
mediaTags com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property mediaTags: The tags of the media asset.
mediaType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property mediaType: The type of the media asset.
overwrite java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property overwrite: Specifies whether to overwrite the media asset that has been registered by using the same URL.
referenceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property referenceId: The custom ID.
registerConfig java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property registerConfig: The registration configurations.
smartTagTemplateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property smartTagTemplateId: The ID of the smart tagging template.
title java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property title: The title.
userData com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property userData: The user data.
workflowId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property workflowId: The workflow ID.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

inputUrlRequired

  • Type: java.lang.String OR com.aliyun.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*

businessTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property businessType: The business type of the media asset.

Valid values: subtitles watermark opening ending general

cateIdOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property cateId: The category ID.

coverUrlOptional

  • Type: java.lang.String OR com.aliyun.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

  • Type: java.lang.String OR com.aliyun.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.

mediaTagsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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.

mediaTypeOptional

  • Type: java.lang.String OR com.aliyun.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

  • Type: java.lang.Boolean OR com.aliyun.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.

referenceIdOptional

  • Type: java.lang.String OR com.aliyun.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.

registerConfigOptional

  • Type: java.lang.String OR com.aliyun.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.

smartTagTemplateIdOptional

  • Type: java.lang.String OR com.aliyun.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

  • Type: java.lang.String OR com.aliyun.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.

userDataOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property userData: The user data.

You can specify a custom callback URL.

workflowIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property workflowId: The workflow ID.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.ice.MediaInfo;
MediaInfo.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrMediaId com.aliyun.ros.cdk.core.IResolvable Attribute MediaId: The ID of the media asset in IMS.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrMediaIdRequired 

public IResolvable getAttrMediaId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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