GetPlayInfoRequest (vod20170321 2.19.1 API)

java.lang.Object
- com.aliyun.tea.TeaModel
- - com.aliyun.vod20170321.models.GetPlayInfoRequest

public class GetPlayInfoRequest
extends com.aliyun.tea.TeaModel

字段概要

字段
限定符和类型	字段和说明
`String`	`additionType` The URL of the masked live comment data.
`Long`	`authTimeout` The validity period of the playback URL.
`String`	`definition` The quality of the video stream.
`String`	`digitalWatermarkType` The type of the digital watermark.
`String`	`formats` The format of the media stream.
`String`	`outputType` The type of the output URL.
`String`	`playConfig` The custom playback configuration.
`String`	`reAuthInfo` The CDN reauthentication configuration.
`String`	`resultType` The type of the data to return.
`String`	`streamType` The type of the media stream.
`String`	`trace` The custom digital watermark.
`String`	`videoId` The ID of the media file.

构造器概要

构造器
构造器和说明

GetPlayInfoRequest()

构造器
构造器和说明
`GetPlayInfoRequest()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static GetPlayInfoRequest`	`build(Map<String,?> map)`
`String`	`getAdditionType()`
`Long`	`getAuthTimeout()`
`String`	`getDefinition()`
`String`	`getDigitalWatermarkType()`
`String`	`getFormats()`
`String`	`getOutputType()`
`String`	`getPlayConfig()`
`String`	`getReAuthInfo()`
`String`	`getResultType()`
`String`	`getStreamType()`
`String`	`getTrace()`
`String`	`getVideoId()`
`GetPlayInfoRequest`	`setAdditionType(String additionType)`
`GetPlayInfoRequest`	`setAuthTimeout(Long authTimeout)`
`GetPlayInfoRequest`	`setDefinition(String definition)`
`GetPlayInfoRequest`	`setDigitalWatermarkType(String digitalWatermarkType)`
`GetPlayInfoRequest`	`setFormats(String formats)`
`GetPlayInfoRequest`	`setOutputType(String outputType)`
`GetPlayInfoRequest`	`setPlayConfig(String playConfig)`
`GetPlayInfoRequest`	`setReAuthInfo(String reAuthInfo)`
`GetPlayInfoRequest`	`setResultType(String resultType)`
`GetPlayInfoRequest`	`setStreamType(String streamType)`
`GetPlayInfoRequest`	`setTrace(String trace)`
`GetPlayInfoRequest`	`setVideoId(String videoId)`

从类继承的方法 com.aliyun.tea.TeaModel
build, buildMap, confirmType, parseObject, toMap, toMap, toModel, validate, validateParams

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - additionType
```
@NameInMap(value="AdditionType")
public String additionType
```
    The URL of the masked live comment data. Set the value to **danmu**.
    
    > This parameter takes effect only when the outputType parameter is set to **cdn**.
  - authTimeout
```
@NameInMap(value="AuthTimeout")
public Long authTimeout
```
    The validity period of the playback URL. Unit: seconds.
    
    * If you set OutputType to **cdn**:
    
    * The playback URL has a validity period only if URL signing is enabled. Otherwise, the playback URL is permanently valid. For more information about how to enable and configure URL signing, see [URL signing](~~86090~~).
    
    * Minimum value: **1**.
    
    * Maximum value: unlimited.
    
    * Default value: The default validity period that is specified in URL signing is used.
    
    * If you set OutputType to **oss**:
    
    * This parameter takes effect only when the ACL of the Object Storage Service (OSS) bucket is private. Otherwise, the playback URL does not expire.
    
    * Minimum value: **1**.
    
    * Maximum value: If the media file is stored in the VOD bucket, the maximum validity period is **2592000** (30 days). If the media file is stored in an OSS bucket, the maximum validity period is **129600** (36 hours). This limit is imposed to reduce security risks of the origin server. If you require a longer validity period, set OutputType to **cdn** and configure URL signing to specify a longer validity period.
    
    * Default value: **3600**.
  - definition
```
@NameInMap(value="Definition")
public String definition
```
    The quality of the video stream. Separate multiple qualities with commas (,). Valid values:
    
    * **FD**: low definition
    
    * **LD**: standard definition
    
    * **SD**: high definition
    
    * **HD**: ultra-high definition
    
    * **OD**: original definition
    
    * **2K**: 2K
    
    * **4K**: 4K
    
    * **SQ**: standard sound quality
    
    * **HQ**: high sound quality
    
    * **AUTO**: adaptive bitrate
    
    > By default, ApsaraVideo VOD returns video streams in all preceding qualities. However, video streams for adaptive bitrate streaming are returned only if the PackageSetting parameter is specified in the transcoding template. For more information, see the [PackageSetting parameter in the TranscodeTemplate](~~52839~~) table.
  - digitalWatermarkType
```
@NameInMap(value="DigitalWatermarkType")
public String digitalWatermarkType
```
    The type of the digital watermark. Valid values:
    
    * TraceMark: tracing watermark
    
    * CopyrightMark: copyright watermark
  - formats
```
@NameInMap(value="Formats")
public String formats
```
    The format of the media stream. Separate multiple formats with commas (,). Valid values:
    
    * **mp4**
    
    * **m3u8**
    
    * **mp3**
    
    * **mpd**
    
    > By default, ApsaraVideo VOD returns video streams in all the preceding formats. However, video streams in the MPD format are returned only if the MPD container format is specified in the transcoding template. For more information, see the [Container parameter in the TranscodeTemplate](~~52839~~) table.
  - outputType
```
@NameInMap(value="OutputType")
public String outputType
```
    The type of the output URL. Default value: oss. Valid values:
    
    * **oss**
    
    * **cdn**
  - playConfig
```
@NameInMap(value="PlayConfig")
public String playConfig
```
    The custom playback configuration. The value is a JSON string. For more information, see [PlayConfig](~~86952~~).
    
    >- If you do not specify PlayConfig or `PlayDomain` in PlayConfig, the default domain name configured in ApsaraVideo VOD is used in this operation. If no default domain name is configured, the domain names are queried in reverse chronological order based on the time when the domain names were modified. The domain name that was last modified is used as the streaming domain name. To prevent domain name issues, we recommend that you specify the default streaming domain name. You can log on to the [ApsaraVideo VOD console](https://vod.console.aliyun.com) and choose **Configuration Management** > **Media Management** > **Storage** > **Manage** > **Origin Domain Name** to set the default streaming domain name.
    
    >- If the `EncryptType` parameter in PlayConfig is set to `AliyunVoDEncryption`, the playback URL of the stream encrypted by using proprietary cryptography is not returned to ensure video security. If you want to return such URL, you must set the `ResultType` parameter to `Multiple`.
  - reAuthInfo
```
@NameInMap(value="ReAuthInfo")
public String reAuthInfo
```
    The CDN reauthentication configuration. The value is a JSON string. If CDN reauthentication is enabled, you can use this parameter to specify the UID and rand fields for URL authentication. For more information, see [URL authentication](~~57007~~).
  - resultType
```
@NameInMap(value="ResultType")
public String resultType
```
    The type of the data to return. Default value: Single. Valid values:
    
    * **Single**: Only one latest transcoded stream is returned for each quality and format.
    
    * **Multiple**: All transcoded streams are returned for each quality and format.
  - streamType
```
@NameInMap(value="StreamType")
public String streamType
```
    The type of the media stream. Separate multiple types with commas (,). Valid values:
    
    * **video**
    
    * **audio**
    
    By default, video and audio streams are returned.
  - trace
```
@NameInMap(value="Trace")
public String trace
```
    The custom digital watermark.
    
    * If you set `DigitalWatermarkType` to `TraceMark`, specify this parameter to configure the video tracing watermark and return the video stream that contains the watermark. The value can be up to 1,024 characters in length and can contain letters and digits.
    
    * If you set `DigitalWatermarkType` to `CopyrightMark`, specify the **watermark text** that you created for the watermark template for this parameter.`` You can specify this parameter to query and return the video stream that contains the specified watermark text.
  - videoId
```
@NameInMap(value="VideoId")
public String videoId
```
    The ID of the media file. You can specify only one ID. You can use one of the following methods to obtain the media ID:
    
    * Log on to the [ApsaraVideo VOD](https://vod.console.aliyun.com) console. In the left-side navigation pane, choose **Media Files** > **Audio/Video**. On the Video and Audio page, you can view the ID of the audio or video file. This method is applicable to files that are uploaded by using the ApsaraVideo VOD console.
    
    * Obtain the value of the VideoId parameter from the response to the [CreateUploadVideo](~~55407~~) operation.
    
    * Obtain the value of the VideoId parameter from the response to the [SearchMedia](~~86044~~) operation. This method is applicable to files that have been uploaded.
- 构造器详细资料
  - GetPlayInfoRequest
```
public GetPlayInfoRequest()
```
- 方法详细资料
  - build
```
public static GetPlayInfoRequest build(Map<String,?> map)
                                throws Exception
```
    抛出:
    
    Exception
  - setAdditionType
```
public GetPlayInfoRequest setAdditionType(String additionType)
```
  - getAdditionType
```
public String getAdditionType()
```
  - setAuthTimeout
```
public GetPlayInfoRequest setAuthTimeout(Long authTimeout)
```
  - getAuthTimeout
```
public Long getAuthTimeout()
```
  - setDefinition
```
public GetPlayInfoRequest setDefinition(String definition)
```
  - getDefinition
```
public String getDefinition()
```
  - setDigitalWatermarkType
```
public GetPlayInfoRequest setDigitalWatermarkType(String digitalWatermarkType)
```
  - getDigitalWatermarkType
```
public String getDigitalWatermarkType()
```
  - setFormats
```
public GetPlayInfoRequest setFormats(String formats)
```
  - getFormats
```
public String getFormats()
```
  - setOutputType
```
public GetPlayInfoRequest setOutputType(String outputType)
```
  - getOutputType
```
public String getOutputType()
```
  - setPlayConfig
```
public GetPlayInfoRequest setPlayConfig(String playConfig)
```
  - getPlayConfig
```
public String getPlayConfig()
```
  - setReAuthInfo
```
public GetPlayInfoRequest setReAuthInfo(String reAuthInfo)
```
  - getReAuthInfo
```
public String getReAuthInfo()
```
  - setResultType
```
public GetPlayInfoRequest setResultType(String resultType)
```
  - getResultType
```
public String getResultType()
```
  - setStreamType
```
public GetPlayInfoRequest setStreamType(String streamType)
```
  - getStreamType
```
public String getStreamType()
```
  - setTrace
```
public GetPlayInfoRequest setTrace(String trace)
```
  - getTrace
```
public String getTrace()
```
  - setVideoId
```
public GetPlayInfoRequest setVideoId(String videoId)
```
  - getVideoId
```
public String getVideoId()
```

类 GetPlayInfoRequest

字段概要

构造器概要

方法概要

从类继承的方法 com.aliyun.tea.TeaModel

从类继承的方法 java.lang.Object

字段详细资料

additionType

authTimeout

definition

digitalWatermarkType

formats

outputType

playConfig

reAuthInfo

resultType

streamType

trace

videoId

构造器详细资料

GetPlayInfoRequest

方法详细资料

build

setAdditionType

getAdditionType

setAuthTimeout

getAuthTimeout

setDefinition

getDefinition

setDigitalWatermarkType

getDigitalWatermarkType

setFormats

getFormats

setOutputType

getOutputType

setPlayConfig

getPlayConfig

setReAuthInfo

getReAuthInfo

setResultType

getResultType

setStreamType

getStreamType

setTrace

getTrace

setVideoId

getVideoId