/** * 腾讯云智能媒资托管服务API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { ConfirmM3u8Upload200Response } from '../models'; import type { ConfirmM3u8UploadRequest } from '../models'; import type { CreateTranscodeTask200Response } from '../models'; import type { CreateTranscodeTaskRequest } from '../models'; import type { GetMediaFileInfo200Response } from '../models'; import type { ModifyM3u8Segments200Response } from '../models'; import type { ModifyM3u8SegmentsRequest } from '../models'; import type { PrepareM3u8Upload200Response } from '../models'; import type { PrepareM3u8Upload201Response } from '../models'; import type { PrepareM3u8UploadRequest } from '../models'; import type { RenewM3u8Upload200Response } from '../models'; import type { RenewM3u8UploadRequest } from '../models'; /** * HlsApi - axios parameter creator */ export declare const HlsApiAxiosParamCreator: (configuration?: Configuration) => { /** * 用于确认 m3u8 上传完成。 接口说明: 将 segments 分成多个批次完成,比如每批100个 ts(有密钥时长度放宽到101个) 先完成 segments,确保所有 ts 和密钥文件都完成后,再完成 playlist 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传完成(确认) * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} confirmKey 为m3u8 上传准备接口响应体中的 confirmKey * @param {ConfirmM3u8UploadConfirmEnum} confirm 确认上传,固定值为 1 * @param {ConfirmM3u8UploadRequest} confirmM3u8UploadRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmM3u8Upload: (libraryId: string, spaceId: string, confirmKey: string, confirm: ConfirmM3u8UploadConfirmEnum, confirmM3u8UploadRequest: ConfirmM3u8UploadRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; /** * 将指定视频转码到模版指定的规格(帧率、码率、分辨率)。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary 视频转码 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {CreateTranscodeTaskTranscodeEnum} transcode 是否转码,固定值为 1 * @param {CreateTranscodeTaskRequest} createTranscodeTaskRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTranscodeTask: (libraryId: string, spaceId: string, filePath: string, transcode: CreateTranscodeTaskTranscodeEnum, createTranscodeTaskRequest: CreateTranscodeTaskRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于查询媒体文件的元信息,包括视频高度、宽度、比特率、时长以及允许使用的转码模板列表 * @summary 查询媒体文件的元信息 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {GetMediaFileInfoInfoEnum} info 是否查询元信息,固定值为 1 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMediaFileInfo: (libraryId: string, spaceId: string, filePath: string, info: GetMediaFileInfoInfoEnum, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 可以直接在视频播放器中指定该 URL,该接口将自动 302 跳转到真实的 m3u8 播放列表 URL。 此接口仅支持将其他格式的源文件转码为 HLS 格式目标文件进行播放,不支持以 HLS 格式作为源文件。 此接口暂不支持播放符号链接文件和文件的历史版本。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary 发起实时转码任务并获取带授权信息的播放列表 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {LiveTranscodeMediaFileLiveTranscodeEnum} liveTranscode 是否发起实时转码,固定值为 1 * @param {LiveTranscodeMediaFileTranscodingTemplateIdEnum} transcodingTemplateId 转码模板ID,可支持的模板列表为: - h264_360p(流畅) - h264_480p(低清) - h264_720p(高清) - h264_1080p(超清) - h264_2K - h264_4K 注意:不允许输入比原视频分辨率更大的转码模板 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ liveTranscodeMediaFile: (libraryId: string, spaceId: string, filePath: string, liveTranscode: LiveTranscodeMediaFileLiveTranscodeEnum, transcodingTemplateId: LiveTranscodeMediaFileTranscodingTemplateIdEnum, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig) => Promise; /** * 用于重传或追加 m3u8 分片文件。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 分片重传与追加 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} confirmKey 为m3u8 上传准备接口响应体中的 confirmKey * @param {ModifyM3u8SegmentsModifyEnum} modify 是否修改,固定值为 1 * @param {ModifyM3u8SegmentsRequest} modifyM3u8SegmentsRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {number} [trafficLimit] 单连接上传限速,范围 100KB/s-100MB/s,单位 Byte * @param {*} [options] Override http request option. * @throws {RequiredError} */ modifyM3u8Segments: (libraryId: string, spaceId: string, confirmKey: string, modify: ModifyM3u8SegmentsModifyEnum, modifyM3u8SegmentsRequest: ModifyM3u8SegmentsRequest, accessToken?: string, librarySecret?: string, trafficLimit?: number, options?: RawAxiosRequestConfig) => Promise; /** * 用于准备 m3u8 播放列表及其分片文件的上传。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传准备 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {PrepareM3u8UploadRequest} prepareM3u8UploadRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数,获取请参见 生成访问令牌 * @param {PrepareM3u8UploadConflictResolutionStrategyEnum} [conflictResolutionStrategy] 文件名冲突时的处理方式, 取值如下: ask:默认值, 冲突时返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码 rename:冲突时自动重命名文件 overwrite:如果冲突目标为目录时返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码,否则覆盖已有文件 * @param {number} [trafficLimit] 单连接上传限速,范围 100KB/s-100MB/s,单位 Byte * @param {*} [options] Override http request option. * @throws {RequiredError} */ prepareM3u8Upload: (libraryId: string, spaceId: string, filePath: string, prepareM3u8UploadRequest: PrepareM3u8UploadRequest, accessToken?: string, conflictResolutionStrategy?: PrepareM3u8UploadConflictResolutionStrategyEnum, trafficLimit?: number, options?: RawAxiosRequestConfig) => Promise; /** * 可选接口,用于对 m3u8 上传任务进行续期,刷新上传信息的有效期。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传续期 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} confirmKey 为m3u8 上传准备接口响应体中的 confirmKey * @param {RenewM3u8UploadRenewEnum} renew 是否续期,固定值为 1 * @param {RenewM3u8UploadRequest} renewM3u8UploadRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {number} [trafficLimit] 单连接上传限速,范围 100KB/s-100MB/s,单位 Byte * @param {*} [options] Override http request option. * @throws {RequiredError} */ renewM3u8Upload: (libraryId: string, spaceId: string, confirmKey: string, renew: RenewM3u8UploadRenewEnum, renewM3u8UploadRequest: RenewM3u8UploadRequest, accessToken?: string, librarySecret?: string, trafficLimit?: number, options?: RawAxiosRequestConfig) => Promise; }; /** * HlsApi - functional programming interface */ export declare const HlsApiFp: (configuration?: Configuration) => { /** * 用于确认 m3u8 上传完成。 接口说明: 将 segments 分成多个批次完成,比如每批100个 ts(有密钥时长度放宽到101个) 先完成 segments,确保所有 ts 和密钥文件都完成后,再完成 playlist 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传完成(确认) * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} confirmKey 为m3u8 上传准备接口响应体中的 confirmKey * @param {ConfirmM3u8UploadConfirmEnum} confirm 确认上传,固定值为 1 * @param {ConfirmM3u8UploadRequest} confirmM3u8UploadRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmM3u8Upload(libraryId: string, spaceId: string, confirmKey: string, confirm: ConfirmM3u8UploadConfirmEnum, confirmM3u8UploadRequest: ConfirmM3u8UploadRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 将指定视频转码到模版指定的规格(帧率、码率、分辨率)。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary 视频转码 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {CreateTranscodeTaskTranscodeEnum} transcode 是否转码,固定值为 1 * @param {CreateTranscodeTaskRequest} createTranscodeTaskRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTranscodeTask(libraryId: string, spaceId: string, filePath: string, transcode: CreateTranscodeTaskTranscodeEnum, createTranscodeTaskRequest: CreateTranscodeTaskRequest, accessToken?: string, librarySecret?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于查询媒体文件的元信息,包括视频高度、宽度、比特率、时长以及允许使用的转码模板列表 * @summary 查询媒体文件的元信息 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {GetMediaFileInfoInfoEnum} info 是否查询元信息,固定值为 1 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMediaFileInfo(libraryId: string, spaceId: string, filePath: string, info: GetMediaFileInfoInfoEnum, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 可以直接在视频播放器中指定该 URL,该接口将自动 302 跳转到真实的 m3u8 播放列表 URL。 此接口仅支持将其他格式的源文件转码为 HLS 格式目标文件进行播放,不支持以 HLS 格式作为源文件。 此接口暂不支持播放符号链接文件和文件的历史版本。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary 发起实时转码任务并获取带授权信息的播放列表 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {LiveTranscodeMediaFileLiveTranscodeEnum} liveTranscode 是否发起实时转码,固定值为 1 * @param {LiveTranscodeMediaFileTranscodingTemplateIdEnum} transcodingTemplateId 转码模板ID,可支持的模板列表为: - h264_360p(流畅) - h264_480p(低清) - h264_720p(高清) - h264_1080p(超清) - h264_2K - h264_4K 注意:不允许输入比原视频分辨率更大的转码模板 * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {string} [userId] 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 * @param {*} [options] Override http request option. * @throws {RequiredError} */ liveTranscodeMediaFile(libraryId: string, spaceId: string, filePath: string, liveTranscode: LiveTranscodeMediaFileLiveTranscodeEnum, transcodingTemplateId: LiveTranscodeMediaFileTranscodingTemplateIdEnum, accessToken?: string, librarySecret?: string, userId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于重传或追加 m3u8 分片文件。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 分片重传与追加 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} confirmKey 为m3u8 上传准备接口响应体中的 confirmKey * @param {ModifyM3u8SegmentsModifyEnum} modify 是否修改,固定值为 1 * @param {ModifyM3u8SegmentsRequest} modifyM3u8SegmentsRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {number} [trafficLimit] 单连接上传限速,范围 100KB/s-100MB/s,单位 Byte * @param {*} [options] Override http request option. * @throws {RequiredError} */ modifyM3u8Segments(libraryId: string, spaceId: string, confirmKey: string, modify: ModifyM3u8SegmentsModifyEnum, modifyM3u8SegmentsRequest: ModifyM3u8SegmentsRequest, accessToken?: string, librarySecret?: string, trafficLimit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 用于准备 m3u8 播放列表及其分片文件的上传。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传准备 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} filePath 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 * @param {PrepareM3u8UploadRequest} prepareM3u8UploadRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数,获取请参见 生成访问令牌 * @param {PrepareM3u8UploadConflictResolutionStrategyEnum} [conflictResolutionStrategy] 文件名冲突时的处理方式, 取值如下: ask:默认值, 冲突时返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码 rename:冲突时自动重命名文件 overwrite:如果冲突目标为目录时返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码,否则覆盖已有文件 * @param {number} [trafficLimit] 单连接上传限速,范围 100KB/s-100MB/s,单位 Byte * @param {*} [options] Override http request option. * @throws {RequiredError} */ prepareM3u8Upload(libraryId: string, spaceId: string, filePath: string, prepareM3u8UploadRequest: PrepareM3u8UploadRequest, accessToken?: string, conflictResolutionStrategy?: PrepareM3u8UploadConflictResolutionStrategyEnum, trafficLimit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 可选接口,用于对 m3u8 上传任务进行续期,刷新上传信息的有效期。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传续期 * @param {string} libraryId 媒体库 ID,必选参数 * @param {string} spaceId 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 * @param {string} confirmKey 为m3u8 上传准备接口响应体中的 confirmKey * @param {RenewM3u8UploadRenewEnum} renew 是否续期,固定值为 1 * @param {RenewM3u8UploadRequest} renewM3u8UploadRequest * @param {string} [accessToken] 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 * @param {string} [librarySecret] 访问媒体库密钥,可选参数 * @param {number} [trafficLimit] 单连接上传限速,范围 100KB/s-100MB/s,单位 Byte * @param {*} [options] Override http request option. * @throws {RequiredError} */ renewM3u8Upload(libraryId: string, spaceId: string, confirmKey: string, renew: RenewM3u8UploadRenewEnum, renewM3u8UploadRequest: RenewM3u8UploadRequest, accessToken?: string, librarySecret?: string, trafficLimit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * HlsApi - factory interface */ export declare const HlsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 用于确认 m3u8 上传完成。 接口说明: 将 segments 分成多个批次完成,比如每批100个 ts(有密钥时长度放宽到101个) 先完成 segments,确保所有 ts 和密钥文件都完成后,再完成 playlist 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传完成(确认) * @param {HlsApiConfirmM3u8UploadRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmM3u8Upload(requestParameters: HlsApiConfirmM3u8UploadRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 将指定视频转码到模版指定的规格(帧率、码率、分辨率)。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary 视频转码 * @param {HlsApiCreateTranscodeTaskRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTranscodeTask(requestParameters: HlsApiCreateTranscodeTaskRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于查询媒体文件的元信息,包括视频高度、宽度、比特率、时长以及允许使用的转码模板列表 * @summary 查询媒体文件的元信息 * @param {HlsApiGetMediaFileInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMediaFileInfo(requestParameters: HlsApiGetMediaFileInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 可以直接在视频播放器中指定该 URL,该接口将自动 302 跳转到真实的 m3u8 播放列表 URL。 此接口仅支持将其他格式的源文件转码为 HLS 格式目标文件进行播放,不支持以 HLS 格式作为源文件。 此接口暂不支持播放符号链接文件和文件的历史版本。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary 发起实时转码任务并获取带授权信息的播放列表 * @param {HlsApiLiveTranscodeMediaFileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ liveTranscodeMediaFile(requestParameters: HlsApiLiveTranscodeMediaFileRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于重传或追加 m3u8 分片文件。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 分片重传与追加 * @param {HlsApiModifyM3u8SegmentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ modifyM3u8Segments(requestParameters: HlsApiModifyM3u8SegmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 用于准备 m3u8 播放列表及其分片文件的上传。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传准备 * @param {HlsApiPrepareM3u8UploadRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ prepareM3u8Upload(requestParameters: HlsApiPrepareM3u8UploadRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 可选接口,用于对 m3u8 上传任务进行续期,刷新上传信息的有效期。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传续期 * @param {HlsApiRenewM3u8UploadRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ renewM3u8Upload(requestParameters: HlsApiRenewM3u8UploadRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for confirmM3u8Upload operation in HlsApi. */ export interface HlsApiConfirmM3u8UploadRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 为m3u8 上传准备接口响应体中的 confirmKey */ readonly confirmKey: string; /** * 确认上传,固定值为 1 */ readonly confirm: ConfirmM3u8UploadConfirmEnum; readonly confirmM3u8UploadRequest: ConfirmM3u8UploadRequest; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * Request parameters for createTranscodeTask operation in HlsApi. */ export interface HlsApiCreateTranscodeTaskRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 是否转码,固定值为 1 */ readonly transcode: CreateTranscodeTaskTranscodeEnum; readonly createTranscodeTaskRequest: CreateTranscodeTaskRequest; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; } /** * Request parameters for getMediaFileInfo operation in HlsApi. */ export interface HlsApiGetMediaFileInfoRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 是否查询元信息,固定值为 1 */ readonly info: GetMediaFileInfoInfoEnum; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; } /** * Request parameters for liveTranscodeMediaFile operation in HlsApi. */ export interface HlsApiLiveTranscodeMediaFileRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; /** * 是否发起实时转码,固定值为 1 */ readonly liveTranscode: LiveTranscodeMediaFileLiveTranscodeEnum; /** * 转码模板ID,可支持的模板列表为: - h264_360p(流畅) - h264_480p(低清) - h264_720p(高清) - h264_1080p(超清) - h264_2K - h264_4K 注意:不允许输入比原视频分辨率更大的转码模板 */ readonly transcodingTemplateId: LiveTranscodeMediaFileTranscodingTemplateIdEnum; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 用户身份识别,当访问令牌对应的权限为管理员权限且申请访问令牌时的用户身份识别为空时用来临时指定用户身份,详情请参阅生成访问令牌接口,可选参数 */ readonly userId?: string; } /** * Request parameters for modifyM3u8Segments operation in HlsApi. */ export interface HlsApiModifyM3u8SegmentsRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 为m3u8 上传准备接口响应体中的 confirmKey */ readonly confirmKey: string; /** * 是否修改,固定值为 1 */ readonly modify: ModifyM3u8SegmentsModifyEnum; readonly modifyM3u8SegmentsRequest: ModifyM3u8SegmentsRequest; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 单连接上传限速,范围 100KB/s-100MB/s,单位 Byte */ readonly trafficLimit?: number; } /** * Request parameters for prepareM3u8Upload operation in HlsApi. */ export interface HlsApiPrepareM3u8UploadRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 文件路径|目录路径,对于多级文件路径,使用斜杠(/)分隔,例如 foo/bar/file.txt;对于根目录,该参数留空 */ readonly filePath: string; readonly prepareM3u8UploadRequest: PrepareM3u8UploadRequest; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数,获取请参见 生成访问令牌 */ readonly accessToken?: string; /** * 文件名冲突时的处理方式, 取值如下: ask:默认值, 冲突时返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码 rename:冲突时自动重命名文件 overwrite:如果冲突目标为目录时返回 HTTP 409 Conflict 及 SameNameDirectoryOrFileExists 错误码,否则覆盖已有文件 */ readonly conflictResolutionStrategy?: PrepareM3u8UploadConflictResolutionStrategyEnum; /** * 单连接上传限速,范围 100KB/s-100MB/s,单位 Byte */ readonly trafficLimit?: number; } /** * Request parameters for renewM3u8Upload operation in HlsApi. */ export interface HlsApiRenewM3u8UploadRequest { /** * 媒体库 ID,必选参数 */ readonly libraryId: string; /** * 空间 ID,如果媒体库为单租户模式,则该参数固定为连字符(-);如果媒体库为多租户模式,则必须指定该参数 */ readonly spaceId: string; /** * 为m3u8 上传准备接口响应体中的 confirmKey */ readonly confirmKey: string; /** * 是否续期,固定值为 1 */ readonly renew: RenewM3u8UploadRenewEnum; readonly renewM3u8UploadRequest: RenewM3u8UploadRequest; /** * 访问令牌,对于公有读媒体库或租户空间,可不指定该参数,否则必须指定该参数 */ readonly accessToken?: string; /** * 访问媒体库密钥,可选参数 */ readonly librarySecret?: string; /** * 单连接上传限速,范围 100KB/s-100MB/s,单位 Byte */ readonly trafficLimit?: number; } /** * HlsApi - object-oriented interface */ export declare class HlsApi extends BaseAPI { /** * 用于确认 m3u8 上传完成。 接口说明: 将 segments 分成多个批次完成,比如每批100个 ts(有密钥时长度放宽到101个) 先完成 segments,确保所有 ts 和密钥文件都完成后,再完成 playlist 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传完成(确认) * @param {HlsApiConfirmM3u8UploadRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmM3u8Upload(requestParameters: HlsApiConfirmM3u8UploadRequest, options?: RawAxiosRequestConfig): Promise>; /** * 将指定视频转码到模版指定的规格(帧率、码率、分辨率)。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary 视频转码 * @param {HlsApiCreateTranscodeTaskRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTranscodeTask(requestParameters: HlsApiCreateTranscodeTaskRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于查询媒体文件的元信息,包括视频高度、宽度、比特率、时长以及允许使用的转码模板列表 * @summary 查询媒体文件的元信息 * @param {HlsApiGetMediaFileInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMediaFileInfo(requestParameters: HlsApiGetMediaFileInfoRequest, options?: RawAxiosRequestConfig): Promise>; /** * 可以直接在视频播放器中指定该 URL,该接口将自动 302 跳转到真实的 m3u8 播放列表 URL。 此接口仅支持将其他格式的源文件转码为 HLS 格式目标文件进行播放,不支持以 HLS 格式作为源文件。 此接口暂不支持播放符号链接文件和文件的历史版本。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary 发起实时转码任务并获取带授权信息的播放列表 * @param {HlsApiLiveTranscodeMediaFileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ liveTranscodeMediaFile(requestParameters: HlsApiLiveTranscodeMediaFileRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于重传或追加 m3u8 分片文件。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 分片重传与追加 * @param {HlsApiModifyM3u8SegmentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ modifyM3u8Segments(requestParameters: HlsApiModifyM3u8SegmentsRequest, options?: RawAxiosRequestConfig): Promise>; /** * 用于准备 m3u8 播放列表及其分片文件的上传。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传准备 * @param {HlsApiPrepareM3u8UploadRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ prepareM3u8Upload(requestParameters: HlsApiPrepareM3u8UploadRequest, options?: RawAxiosRequestConfig): Promise>; /** * 可选接口,用于对 m3u8 上传任务进行续期,刷新上传信息的有效期。 权限说明: 要求 space_admin 权限 或 admin 权限,有关权限详情请参见 生成访问令牌接口 * @summary m3u8 上传续期 * @param {HlsApiRenewM3u8UploadRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ renewM3u8Upload(requestParameters: HlsApiRenewM3u8UploadRequest, options?: RawAxiosRequestConfig): Promise>; } export declare const ConfirmM3u8UploadConfirmEnum: { readonly NUMBER_1: 1; }; export type ConfirmM3u8UploadConfirmEnum = typeof ConfirmM3u8UploadConfirmEnum[keyof typeof ConfirmM3u8UploadConfirmEnum]; export declare const CreateTranscodeTaskTranscodeEnum: { readonly NUMBER_1: 1; }; export type CreateTranscodeTaskTranscodeEnum = typeof CreateTranscodeTaskTranscodeEnum[keyof typeof CreateTranscodeTaskTranscodeEnum]; export declare const GetMediaFileInfoInfoEnum: { readonly NUMBER_1: 1; }; export type GetMediaFileInfoInfoEnum = typeof GetMediaFileInfoInfoEnum[keyof typeof GetMediaFileInfoInfoEnum]; export declare const LiveTranscodeMediaFileLiveTranscodeEnum: { readonly NUMBER_1: 1; }; export type LiveTranscodeMediaFileLiveTranscodeEnum = typeof LiveTranscodeMediaFileLiveTranscodeEnum[keyof typeof LiveTranscodeMediaFileLiveTranscodeEnum]; export declare const LiveTranscodeMediaFileTranscodingTemplateIdEnum: { readonly H264360p: "h264_360p"; readonly H264480p: "h264_480p"; readonly H264720p: "h264_720p"; readonly H2641080p: "h264_1080p"; readonly H2642K: "h264_2K"; readonly H2644K: "h264_4K"; }; export type LiveTranscodeMediaFileTranscodingTemplateIdEnum = typeof LiveTranscodeMediaFileTranscodingTemplateIdEnum[keyof typeof LiveTranscodeMediaFileTranscodingTemplateIdEnum]; export declare const ModifyM3u8SegmentsModifyEnum: { readonly NUMBER_1: 1; }; export type ModifyM3u8SegmentsModifyEnum = typeof ModifyM3u8SegmentsModifyEnum[keyof typeof ModifyM3u8SegmentsModifyEnum]; export declare const PrepareM3u8UploadConflictResolutionStrategyEnum: { readonly Ask: "ask"; readonly Rename: "rename"; readonly Overwrite: "overwrite"; }; export type PrepareM3u8UploadConflictResolutionStrategyEnum = typeof PrepareM3u8UploadConflictResolutionStrategyEnum[keyof typeof PrepareM3u8UploadConflictResolutionStrategyEnum]; export declare const RenewM3u8UploadRenewEnum: { readonly NUMBER_1: 1; }; export type RenewM3u8UploadRenewEnum = typeof RenewM3u8UploadRenewEnum[keyof typeof RenewM3u8UploadRenewEnum];