MediaClient

Cliente para operaciones de contenido multimedia

Este cliente proporciona métodos para interactuar con los endpoints de contenido multimedia de la X API. Se encarga de la autenticación, el formato de las solicitudes y el procesamiento de las respuestas para todas las operaciones relacionadas con contenido multimedia.

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

• initializeUpload
• createSubtitles
• deleteSubtitles

​

Constructores

​

constructor

• new MediaClient(client): MediaClient

Crea una nueva instancia de MediaClient

​

Parámetros

Nombre	type	Descripción
client	Client	La instancia principal del Client de la X API

​

Devuelve

MediaClient

​

Definido en

media/client.ts:250

​

Métodos

​

getByKey

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

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

​

Parámetros

Nombre	Tipo	Descripción
mediaKey	string	Una sola Media Key.
options	GetByKeyOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

media/client.ts:295

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

​

Parámetros

Nombre	Type
mediaKey	string
options?	GetByKeyOptions

​

Devuelve

Promise<Get2MediaMediaKeyResponse>

​

Definido en

media/client.ts:308

---

​

getUploadStatus

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

Obtener el estado de la carga de contenido multimedia
Obtiene el estado de una carga de contenido multimedia por su identificador.

​

Parámetros

Nombre	Tipo	Descripción
mediaId	string	id de contenido multimedia para el estado de la carga solicitada.
options	GetUploadStatusOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

Promise que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

media/client.ts:442

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

​

Parámetros

Nombre	Tipo
mediaId	string
options?	GetUploadStatusOptions

​

Devuelve

Promise<MediaUploadResponse>

​

Definido en

media/client.ts:455

---

​

upload

▸ upload(options): Promise<Response>

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

​

Parámetros

Nombre	type
options	UploadOptions & { requestOptions: { raw: true } }

​

Devuelve

Promise<Response>

Promise que se resuelve en la respuesta de la API o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

media/client.ts:582

▸ upload(options?): Promise<MediaUploadResponse>

​

Parámetros

Nombre	Tipo
options?	UploadOptions

​

Devuelve

Promise<MediaUploadResponse>

​

Definido en

media/client.ts:591

---

​

getAnalytics

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

Obtener analítica de contenido multimedia Obtiene datos de analítica para contenido multimedia.

​

Parámetros

Name	Type	Description
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 para los resultados de los conteos de búsqueda.
options	GetAnalyticsOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o un Response sin procesar si requestOptions.raw es true

​

Definido en

media/client.ts:699

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

​

Parámetros

Nombre	Tipo
mediaKeys	any[]
endTime	string
startTime	string
granularity	string
options?	GetAnalyticsOptions

​

Devuelve

Promise<MediaAnalytics>

​

Definido en

media/client.ts:724

---

​

appendUpload

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

Agregar a la carga de contenido multimedia
Agrega datos a una solicitud de carga de contenido multimedia.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador multimedia del contenido sobre el que se realizará la operación de anexado.
options	AppendUploadOptions & { requestOptions: { raw: true } }	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API o, si requestOptions.raw es true, con el objeto Response sin procesar

​

Definido en

media/client.ts:918

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

​

Parámetros

Nombre	Tipo
id	string
options?	AppendUploadOptions

​

Devuelve

Promise<MediaUploadAppendResponse>

​

Definido en

media/client.ts:931

---

​

getByKeys

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

Obtener archivos multimedia por media keys Recupera los detalles de archivos multimedia a partir de sus media keys.

​

Parámetros

Nombre	Tipo	Descripción
mediaKeys	any[]	Una lista de Media Keys separadas por comas. Se permiten hasta 100 en una única solicitud.
options	GetByKeysOptions & { requestOptions: { raw: true } }	-

​

Returns

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

media/client.ts:1039

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

​

Parámetros

Nombre	Tipo
mediaKeys	any[]
options?	GetByKeysOptions

​

Devuelve

Promise<Get2MediaResponse>

​

Definido en

media/client.ts:1052

---

​

createMetadata

▸ createMetadata(options): Promise<Response>

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

​

Parámetros

Nombre	Type
options	CreateMetadataOptions & { requestOptions: { raw: true } }

​

Devuelve

Promise<Response>

Promise que se resuelve en la respuesta de la API, o un objeto Response sin procesar si requestOptions.raw es true

​

Definido en

media/client.ts:1191

▸ createMetadata(options?): Promise<MetadataCreateResponse>

​

Parámetros

Nombre	Tipo
options?	CreateMetadataOptions

​

Devuelve

Promise<MetadataCreateResponse>

​

Definido en

media/client.ts:1200

---

​

finalizeUpload

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

Finalizar la carga de contenido multimedia
Finaliza una solicitud de carga de contenido multimedia.

​

Parámetros

Nombre	Tipo	Descripción
id	string	El identificador del contenido multimedia que se va a finalizar.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

​

Devuelve

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o un objeto Response sin procesar si requestOptions.raw es true

​

Definido en

media/client.ts:1296

▸ finalizeUpload(id): Promise<MediaUploadResponse>

​

Parámetros

Nombre	Tipo
id	string

​

Devuelve

Promise<MediaUploadResponse>

​

Definido en

media/client.ts:1309

---

​

initializeUpload

▸ initializeUpload(options): Promise<Response>

Inicializar la carga de medios Inicializa la carga de medios.

​

Parámetros

Nombre	Tipo
options	InitializeUploadOptions & { requestOptions: { raw: true } }

​

Devuelve

Promise<Response>

Promise que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

media/client.ts:1396

▸ initializeUpload(options?): Promise<MediaUploadResponse>

​

Parámetros

Nombre	Type
options?	InitializeUploadOptions

​

Devuelve

Promise<MediaUploadResponse>

​

Definido en

media/client.ts:1405

---

​

createSubtitles

▸ createSubtitles(options): Promise<Response>

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

​

Parámetros

Nombre	Tipo
options	CreateSubtitlesOptions & { requestOptions: { raw: true } }

​

Devuelve

Promise<Response>

Promesa que se resuelve en la respuesta de la API, o en el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

media/client.ts:1497

▸ createSubtitles(options?): Promise<SubtitlesCreateResponse>

​

Parámetros

Nombre	type
options?	CreateSubtitlesOptions

​

Devuelve

Promise<SubtitlesCreateResponse>

​

Definido en

media/client.ts:1506

---

​

deleteSubtitles

▸ deleteSubtitles(options): Promise<Response>

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

​

Parámetros

Nombre	type
options	DeleteSubtitlesOptions & { requestOptions: { raw: true } }

​

Returns

Promise<Response>

Promesa que se resuelve con la respuesta de la API, o con el objeto Response sin procesar si requestOptions.raw es true

​

Definido en

media/client.ts:1598

▸ deleteSubtitles(options?): Promise<SubtitlesDeleteResponse>

​

Parámetros

Nombre	type
options?	DeleteSubtitlesOptions

​

Devuelve

Promise<SubtitlesDeleteResponse>

​

Definido en

media/client.ts:1607