MediaClient

미디어 작업용 클라이언트

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

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

​

생성자

​

constructor

• new MediaClient(client): MediaClient

새 미디어 클라이언트 인스턴스를 생성합니다

​

매개변수

이름	타입	설명
client	Client	주 X API 클라이언트 인스턴스

​

반환값

MediaClient

​

정의된 위치

media/client.ts:181

​

메서드

​

getAnalytics

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

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

​

매개변수

Name	Type	Description
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 응답으로 resolve되는 Promise

​

정의 위치

media/client.ts:314

---

​

deleteSubtitles

▸ deleteSubtitles(options?): Promise<SubtitlesDeleteResponse>

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

​

파라미터

이름	타입
options	DeleteSubtitlesOptions

​

반환값

Promise<SubtitlesDeleteResponse>

API 응답으로 resolve되는 Promise입니다.

​

정의됨

media/client.ts:355

---

​

createMetadata

▸ createMetadata(options?): Promise<MetadataCreateResponse>

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

​

매개 변수

이름	유형
options	CreateMetadataOptions

​

반환

Promise<MetadataCreateResponse>

API 응답으로 resolve되는 Promise

​

정의된 위치

media/client.ts:396

---

​

getByKey

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

미디어 키로 Media 가져오기 해당 미디어 키로 특정 Media 파일의 상세 정보를 가져옵니다.

​

매개변수

이름	유형	설명
mediaKey	string	단일 미디어 키.
options	GetByKeyOptions	-

​

반환

Promise<Get2MediaMediaKeyResponse>

API 응답으로 이행되는 Promise

​

정의된 위치

media/client.ts:441

---

​

getByKeys

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

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

​

매개변수

이름	유형	설명
mediaKeys	any[]	쉼표로 구분된 Media Key 목록입니다. 한 번의 요청에서 최대 100개까지 가능합니다.
options	GetByKeysOptions	-

​

반환

Promise<Get2MediaResponse>

API 응답으로 해석되는 Promise

​

정의 위치

media/client.ts:491

---

​

finalizeUpload

▸ finalizeUpload(id): Promise<MediaUploadResponse>

미디어 업로드 완료 미디어 업로드 요청을 완료합니다.

​

매개변수

이름	유형	설명
id	string	최종 확정할 대상 미디어의 media id입니다.

​

반환값

Promise<MediaUploadResponse>

API 응답으로 resolve되는 Promise

​

정의된 위치

media/client.ts:543

---

​

getUploadStatus

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

미디어 업로드 상태 조회 id로 특정 미디어 업로드의 상태를 조회합니다.

​

매개변수

이름	타입	설명
mediaId	any	요청된 미디어 업로드 상태를 위한 미디어 id입니다.
options	GetUploadStatusOptions	-

​

반환

Promise<MediaUploadResponse>

API 응답으로 resolve되는 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	append 작업을 수행할 대상 미디어의 식별자입니다.
options	AppendUploadOptions	-

​

반환

Promise<MediaUploadAppendResponse>

API 응답으로 해석(해결)되는 Promise

​

정의 위치

media/client.ts:672