MediaClient

媒体操作客户端

该客户端提供与 X API 的媒体端点交互的方法，负责处理所有媒体相关操作的身份验证、请求格式化和响应解析。

• initializeUpload
• createSubtitles
• deleteSubtitles
• createMetadata
• getByKey
• getByKeys
• finalizeUpload
• getUploadStatus
• upload
• appendUpload

​

构造器

​

构造函数

• new MediaClient(client): MediaClient

创建一个新的媒体客户端实例

​

参数

名称	类型	说明
client	Client	X API 的主要客户端实例

​

返回值

MediaClient

​

定义于

media/client.ts:181

​

方法

​

getAnalytics

▸ getAnalytics(mediaKeys, endTime, startTime, granularity, options?): Promise<MediaAnalytics>

获取媒体分析 检索媒体的分析数据。

​

参数

名称	类型	描述
mediaKeys	any[]	以逗号分隔的媒体键列表。单个请求最多可包含 100 个。
endTime	string	YYYY-MM-DDTHH:mm:ssZ。表示时间范围结束的 UTC 时间戳。
startTime	string	YYYY-MM-DDTHH:mm:ssZ。表示时间范围开始的 UTC 时间戳。
granularity	string	搜索计数结果的粒度。
options	GetAnalyticsOptions	-

​

返回

Promise<MediaAnalytics>

解析为 API 响应的 Promise

​

定义位置

media/client.ts:210

---

​

initializeUpload

▸ initializeUpload(options?): Promise<MediaUploadResponse>

初始化媒体上传 初始化媒体上传流程。

​

参数

名称	类型
options	InitializeUploadOptions

​

返回

Promise<MediaUploadResponse>

解析为 API 响应的 Promise

​

定义位置

media/client.ts:273

---

​

createSubtitles

▸ createSubtitles(options?): Promise<SubtitlesCreateResponse>

创建媒体字幕 为指定的媒体文件生成字幕。

​

参数

名称	类型
options	CreateSubtitlesOptions

​

返回

Promise<SubtitlesCreateResponse>

解析为 API 响应的 Promise

​

定义位置

media/client.ts:314

---

​

deleteSubtitles

▸ deleteSubtitles(options?): Promise<SubtitlesDeleteResponse>

删除媒体字幕 删除指定媒体文件的字幕。

​

参数

名称	类型
options	DeleteSubtitlesOptions

​

返回

Promise<SubtitlesDeleteResponse>

解析为 API 响应的 Promise

​

定义于

media/client.ts:355

---

​

createMetadata

▸ createMetadata(options?): Promise<MetadataCreateResponse>

创建媒体文件的元数据 为媒体文件生成元数据。

​

参数

名称	类型
options	CreateMetadataOptions

​

返回

Promise<MetadataCreateResponse>

解析为 API 响应的 Promise

​

定义位置

media/client.ts:396

---

​

getByKey

▸ getByKey(mediaKey, options?): Promise<Get2MediaMediaKeyResponse>

按 media key 获取媒体 根据其 media key 获取指定媒体文件的详细信息。

​

参数

名称	类型	说明
mediaKey	string	单个媒体键（Media Key）。
options	GetByKeyOptions	-

​

返回

Promise<Get2MediaMediaKeyResponse>

解析为 API 响应的 Promise

​

定义于

media/client.ts:441

---

​

getByKeys

▸ getByKeys(mediaKeys, options?): Promise<Get2MediaResponse>

根据 media key 获取媒体 通过其 media key 检索媒体文件的详细信息。

​

参数

名称	类型	描述
mediaKeys	any[]	以逗号分隔的媒体键列表。单个请求最多可包含 100 个。
options	GetByKeysOptions	-

​

返回

Promise<Get2MediaResponse>

解析为 API 响应的 Promise

​

定义位置

media/client.ts:491

---

​

finalizeUpload

▸ finalizeUpload(id): Promise<MediaUploadResponse>

完成媒体上传 对媒体上传请求进行最终确认。

​

参数

名称	类型	说明
id	string	需最终确定的目标媒体的媒体 id。

​

返回

Promise<MediaUploadResponse>

解析为 API 响应的 Promise

​

定义于

media/client.ts:543

---

​

getUploadStatus

▸ getUploadStatus(mediaId, options?): Promise<MediaUploadResponse>

获取媒体上传状态 根据其 id 获取媒体上传状态。

​

参数

名称	类型	描述
mediaId	any	用于查询上传状态的媒体 id。
options	GetUploadStatusOptions	-

​

返回

Promise<MediaUploadResponse>

一个最终解析为 API 响应的 Promise

​

定义于

media/client.ts:581

---

​

upload

▸ upload(options?): Promise<MediaUploadResponse>

上传媒体 上传媒体文件，以用于 Post 或其他内容。

​

参数

名称	类型
options	UploadOptions

​

返回

Promise<MediaUploadResponse>

一个会解析为 API 响应的 Promise

​

定义于

media/client.ts:629

---

​

appendUpload

▸ appendUpload(id, options?): Promise<MediaUploadAppendResponse>

追加媒体上传 向媒体上传请求追加 data。

​

参数

名称	类型	描述
id	string	要执行追加操作的媒体的标识符。
options	AppendUploadOptions	-

​

返回

Promise<MediaUploadAppendResponse>

解析为 API 响应的 Promise

​

定义位置

media/client.ts:672