MediaClient

미디어 작업을 위한 Client

이 Client는 X API의 미디어 엔드포인트와 상호 작용하기 위한 메서드를 제공합니다. 모든 미디어 관련 작업에 대해 인증, 요청 포맷팅, 응답 파싱을 처리합니다.

zeUpload](/xdks/typescript/reference/classes/MediaClient#finalizeupload)

• initializeUpload
• createSubtitles
• deleteSubtitles

​

생성자

​

constructor

• new MediaClient(client): MediaClient

새 MediaClient 인스턴스를 생성합니다

​

매개변수

이름	타입	설명
client	Client	주요 X API Client 인스턴스

​

반환

MediaClient

​

정의 위치

media/client.ts:250

​

메서드

​

getByKey

▸ getByKey(mediaKey, options): Promise<Response>

미디어 키로 미디어 가져오기
지정된 미디어 키로 특정 미디어 파일의 세부 정보를 조회합니다.

​

매개변수

Name	Type	Description
mediaKey	string	하나의 미디어 키.
options	GetByKeyOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response를 반환합니다

​

정의 위치

media/client.ts:295

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

​

매개변수

이름	Type
mediaKey	string
options?	GetByKeyOptions

​

반환값

Promise<Get2MediaMediaKeyResponse>

​

정의된 위치

media/client.ts:308

---

​

getUploadStatus

▸ getUploadStatus(mediaId, options): Promise<Response>

미디어 업로드 상태 가져오기 해당 업로드 id로 미디어 업로드 상태를 조회합니다.

​

Parameters

Name	Type	Description
mediaId	string	요청한 미디어 업로드 상태를 조회할 미디어의 id입니다.
options	GetUploadStatusOptions & { requestOptions: { raw: true } }	-

​

반환 값

Promise<Response>

API 응답을 resolve하는 Promise이며, requestOptions.raw가 true인 경우 원시 Response를 반환합니다

​

정의 위치

media/client.ts:442

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

​

매개변수

이름	타입
mediaId	string
options?	GetUploadStatusOptions

​

반환

Promise<MediaUploadResponse>

​

정의된 위치

media/client.ts:455

---

​

upload

▸ upload(options): Promise<Response>

미디어 업로드 포스트나 기타 콘텐츠에서 사용할 미디어 파일을 업로드합니다.

​

매개변수

이름	Type
options	UploadOptions & { requestOptions: { raw: true } }

​

Returns

Promise<Response>

API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response

​

정의된 위치

media/client.ts:582

▸ upload(options?): Promise<MediaUploadResponse>

​

매개변수

이름	type
options?	UploadOptions

​

반환값

Promise<MediaUploadResponse>

​

정의된 위치

media/client.ts:591

---

​

getAnalytics

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

미디어 분석 데이터 가져오기 미디어에 대한 분석 데이터를 조회합니다.

​

매개변수

Name	Type	Description
mediaKeys	any[]	쉼표로 구분된 Media Key 리스트입니다. 단일 요청당 최대 100개까지 허용됩니다.
endTime	string	YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 종료 시점을 나타내는 UTC 타임스탬프입니다.
startTime	string	YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 시작 시점을 나타내는 UTC 타임스탬프입니다.
granularity	string	검색 수 결과의 세분화 수준입니다.
options	GetAnalyticsOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise입니다. requestOptions.raw가 true인 경우에는 원시 Response가 반환됩니다.

​

정의된 위치

media/client.ts:699

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

​

매개변수

이름	type
mediaKeys	any[]
endTime	string
startTime	string
granularity	string
options?	GetAnalyticsOptions

​

반환 값

Promise<MediaAnalytics>

​

정의 위치

media/client.ts:724

---

​

appendUpload

▸ appendUpload(id, options): Promise<Response>

미디어 업로드 이어서 추가
미디어 업로드 요청에 데이터를 이어서 추가합니다.

​

매개변수

Name	Type	Description
id	string	append 작업을 수행할 미디어의 식별자입니다.
options	AppendUploadOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response가 반환됩니다.

​

정의된 위치

media/client.ts:918

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

​

매개변수

이름	타입
id	string
options?	AppendUploadOptions

​

반환

Promise<MediaUploadAppendResponse>

​

정의된 위치

media/client.ts:931

---

​

getByKeys

▸ getByKeys(mediaKeys, options): Promise<Response>

미디어 키로 미디어 가져오기
미디어 키를 사용하여 미디어 파일의 세부 정보를 조회합니다.

​

매개변수

이름	type	설명
mediaKeys	any[]	콤마로 구분된 Media Key 리스트입니다. 한 요청에서 최대 100개까지 허용됩니다.
options	GetByKeysOptions & { requestOptions: { raw: true } }	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response

​

정의 위치

media/client.ts:1039

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

​

매개변수

이름	type
mediaKeys	any[]
options?	GetByKeysOptions

​

반환

Promise<Get2MediaResponse>

​

정의 위치

media/client.ts:1052

---

​

createMetadata

▸ createMetadata(options): Promise<Response>

미디어 메타데이터 생성 미디어 파일의 메타데이터를 생성합니다.

​

매개변수

이름	타입
options	CreateMetadataOptions & { requestOptions: { raw: true } }

​

반환

Promise<Response>

API 응답으로 resolve되는 Promise이거나, requestOptions.raw가 true인 경우 원시 Response 객체

​

정의 위치

media/client.ts:1191

▸ createMetadata(options?): Promise<MetadataCreateResponse>

​

매개변수

이름	타입
options?	CreateMetadataOptions

​

반환

Promise<MetadataCreateResponse>

​

정의된 위치

media/client.ts:1200

---

​

finalizeUpload

▸ finalizeUpload(id, options): Promise<Response>

미디어 업로드 최종 처리 미디어 업로드 요청을 완료합니다.

​

매개변수

Name	Type	Description
id	string	업로드를 최종 완료할 대상 미디어의 media id입니다.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response를 반환합니다.

​

정의 위치

media/client.ts:1296

▸ finalizeUpload(id): Promise<MediaUploadResponse>

​

매개변수

이름	타입
id	string

​

반환

Promise<MediaUploadResponse>

​

정의된 위치

media/client.ts:1309

---

​

initializeUpload

▸ initializeUpload(options): Promise<Response>

미디어 업로드 초기화
미디어 업로드를 초기화합니다.

​

매개변수

이름	type
options	InitializeUploadOptions & { requestOptions: { raw: true } }

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원본 Response를 반환합니다

​

정의 위치

media/client.ts:1396

▸ initializeUpload(options?): Promise<MediaUploadResponse>

​

매개변수

이름	type
options?	InitializeUploadOptions

​

반환

Promise<MediaUploadResponse>

​

정의된 위치

media/client.ts:1405

---

​

createSubtitles

▸ createSubtitles(options): Promise<Response>

미디어 자막 만들기 특정 미디어 파일의 자막을 생성합니다.

​

매개변수

이름	type
options	CreateSubtitlesOptions & { requestOptions: { raw: true } }

​

Returns

Promise<Response>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response를 반환합니다

​

정의 위치

media/client.ts:1497

▸ createSubtitles(options?): Promise<SubtitlesCreateResponse>

​

매개변수

이름	type
options?	CreateSubtitlesOptions

​

반환값

Promise<SubtitlesCreateResponse>

​

정의된 위치

media/client.ts:1506

---

​

deleteSubtitles

▸ deleteSubtitles(options): Promise<Response>

미디어 자막 삭제 특정 미디어 파일에 대한 자막을 삭제합니다.

​

매개변수

이름	type
options	DeleteSubtitlesOptions & { requestOptions: { raw: true } }

​

반환값

Promise<Response>

API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원본 Response

​

정의된 곳

media/client.ts:1598

▸ deleteSubtitles(options?): Promise<SubtitlesDeleteResponse>

​

매개변수

이름	type
options?	DeleteSubtitlesOptions

​

반환 값

Promise<SubtitlesDeleteResponse>

​

정의 위치

media/client.ts:1607