MediaClient

Cliente para operaciones de medios

Este cliente proporciona métodos para interactuar con los endpoints de medios de la X API. Se encarga de la autenticación, el formateo de las solicitudes y el análisis de las respuestas para todas las operaciones relacionadas con medios.

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

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

​

Constructores

​

constructor

• new MediaClient(client): MediaClient

Crea una nueva instancia de MediaClient

​

Parámetros

Nombre	Tipo	Descripción
client	Client	Instancia principal del cliente de la X API

​

Devuelve

MediaClient

​

Definido en

media/client.ts:181

​

Métodos

​

getAnalytics

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

Obtener analíticas de medios Recupera datos de analíticas de medios.

​

Parámetros

Nombre	Tipo	Descripción
mediaKeys	any[]	Una lista de Media Keys separadas por comas. Se permiten hasta 100 en una sola solicitud.
endTime	string	YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC que representa el final del intervalo de tiempo.
startTime	string	YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC que representa el inicio del intervalo de tiempo.
granularity	string	La granularidad de los resultados del conteo de búsqueda.
options	GetAnalyticsOptions	-

​

Retornos

Promise<MediaAnalytics>

Promesa que se resuelve con la respuesta de la API

​

Definido en

media/client.ts:210

---

​

initializeUpload

▸ initializeUpload(options?): Promise<MediaUploadResponse>

Iniciar la carga de medios Inicializa una carga de medios.

​

Parámetros

Nombre	Tipo
options	InitializeUploadOptions

​

Devuelve

Promise<MediaUploadResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

media/client.ts:273

---

​

createSubtitles

▸ createSubtitles(options?): Promise<SubtitlesCreateResponse>

Crear subtítulos de Media Crea subtítulos para un archivo de Media específico.

​

Parámetros

Nombre	Tipo
options	CreateSubtitlesOptions

​

Devuelve

Promise<SubtitlesCreateResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

media/client.ts:314

---

​

deleteSubtitles

▸ deleteSubtitles(options?): Promise<SubtitlesDeleteResponse>

Eliminar subtítulos de Media Elimina los subtítulos de un archivo de Media específico.

​

Parámetros

Nombre	Tipo
options	DeleteSubtitlesOptions

​

Devuelve

Promise<SubtitlesDeleteResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

media/client.ts:355

---

​

createMetadata

▸ createMetadata(options?): Promise<MetadataCreateResponse>

Crear metadatos de Media Crea metadatos para un archivo de Media.

​

Parámetros

Nombre	Tipo
options	CreateMetadataOptions

​

Devuelve

Promise<MetadataCreateResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

media/client.ts:396

---

​

getByKey

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

Obtener Media por media key Recupera los detalles de un archivo de Media específico mediante su media key.

​

Parámetros

Nombre	Tipo	Descripción
mediaKey	string	Una única Media Key.
options	GetByKeyOptions	-

​

Devuelve

Promise<Get2MediaMediaKeyResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

media/client.ts:441

---

​

getByKeys

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

Obtener medios por claves de medios Recupera los detalles de archivos multimedia mediante sus claves de medios.

​

Parámetros

Nombre	Tipo	Descripción
mediaKeys	any[]	Una lista de Media Keys separada por comas. Se permiten hasta 100 en una sola solicitud.
options	GetByKeysOptions	-

​

Devuelve

Promise<Get2MediaResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

media/client.ts:491

---

​

finalizeUpload

▸ finalizeUpload(id): Promise<MediaUploadResponse>

Finalizar carga de medios Finaliza una solicitud de carga de medios.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El id del medio de destino que se debe finalizar.

​

Devuelve

Promise<MediaUploadResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

media/client.ts:543

---

​

getUploadStatus

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

Obtener el estado de la carga de contenido multimedia Recupera el estado de una carga de contenido multimedia por su id.

​

Parámetros

Nombre	Tipo	Descripción
mediaId	any	id del medio para el estado de la carga solicitado.
options	GetUploadStatusOptions	-

​

Devuelve

Promise<MediaUploadResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

media/client.ts:581

---

​

upload

▸ upload(options?): Promise<MediaUploadResponse>

Cargar contenido multimedia Carga un archivo multimedia para usarlo en Posts u otros contenidos.

​

Parámetros

Nombre	Tipo
options	UploadOptions

​

Devuelve

Promise<MediaUploadResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

media/client.ts:629

---

​

appendUpload

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

Anexar carga de medios Anexa datos a una solicitud de carga de medios.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del medio al que se le realizará la operación de anexado.
options	AppendUploadOptions	-

​

Devuelve

Promise<MediaUploadAppendResponse>

Promesa que se resuelve con la respuesta de la API

​

Definido en

media/client.ts:672