Skip to content

InsertMediaToSearchLibProps

Properties for defining a InsertMediaToSearchLib.

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

Initializer 

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

Properties

Name Type Description
input string | @alicloud/ros-cdk-core.IResolvable Property input: The URL of the video, audio, or image file that you want to import to the search library.
mediaId string | @alicloud/ros-cdk-core.IResolvable Property mediaId: The ID of the media asset.
mediaType string | @alicloud/ros-cdk-core.IResolvable Property mediaType: The type of the media asset.
msgBody @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property msgBody: The message body.
searchLibName string | @alicloud/ros-cdk-core.IResolvable Property searchLibName: The name of the search library.

inputRequired 

public readonly input: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property input: The URL of the video, audio, or image file that you want to import to the search library.

Note: Make sure that you specify a correct file name and the bucket in which the file resides is in the same region where this operation is called. Otherwise, the file cannot be found or the operation may fail. Specify an Object Storage Service (OSS) URL in the following format: oss:\/\/[Bucket name]\/[File path]. For example, you can specify oss:\/\/[example-bucket-]\/[object_path-]. Specify an HTTP URL in the following format: public endpoint. For example, you can specify http:\/\/example-test-****.mp4.

mediaIdOptional 

public readonly mediaId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property mediaId: The ID of the media asset.

Each media ID is unique. If you leave this parameter empty, a media ID is automatically generated for this parameter.

mediaTypeOptional 

public readonly mediaType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property mediaType: The type of the media asset.

Valid values: video (default) image audio

msgBodyOptional 

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

Property msgBody: The message body.

searchLibNameOptional 

public readonly searchLibName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property searchLibName: The name of the search library.

Default value: ims-default-search-lib.