Documentation Index
Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Client pour les opérations sur les médias
Ce client fournit des méthodes pour interagir avec les endpoints de médias
de la X API. Il gère l’authentification, le formatage des requêtes et l’analyse des
réponses pour toutes les opérations liées aux médias.
zeUpload](/xdks/typescript/reference/classes/MediaClient#finalizeupload)
• new MediaClient(client): MediaClient
Crée une nouvelle instance de MediaClient
| Name | Type | Description |
|---|
client | Client | Instance principale de Client pour la X API |
Renvoie
MediaClient
Défini dans
media/client.ts:250
▸ getByKey(mediaKey, options): Promise<Response>
Obtenir un média à partir de sa clé média
Récupère les détails d’un fichier média spécifique identifié par sa clé média.
| Nom | Type | Description |
|---|
mediaKey | string | Une unique Media Key. |
options | GetByKeyOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est true
Défini dans
media/client.ts:295
▸ getByKey(mediaKey, options?): Promise<Get2MediaMediaKeyResponse>
| Nom | Type |
|---|
mediaKey | string |
options? | GetByKeyOptions |
Renvoie
Promise<Get2MediaMediaKeyResponse>
Défini dans
media/client.ts:308
▸ getUploadStatus(mediaId, options): Promise<Response>
Obtenir l’état de téléversement d’un média
Récupère l’état de téléversement d’un média à partir de son identifiant.
| Nom | Type | Description |
|---|
mediaId | string | ID du média pour l’état de téléversement demandé. |
options | GetUploadStatusOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true
Défini dans
media/client.ts:442
▸ getUploadStatus(mediaId, options?): Promise<MediaUploadResponse>
| Nom | Type |
|---|
mediaId | string |
options? | GetUploadStatusOptions |
Renvoie
Promise<MediaUploadResponse>
Défini dans
media/client.ts:455
▸ upload(options): Promise<Response>
Téléversement de média
Téléverse un fichier média à utiliser dans des Publications ou d’autres contenus.
| Nom | Type |
|---|
options | UploadOptions & { requestOptions: { raw: true } } |
Renvoie
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est true
Défini dans
media/client.ts:582
▸ upload(options?): Promise<MediaUploadResponse>
| Nom | Type |
|---|
options? | UploadOptions |
Renvoie
Promise<MediaUploadResponse>
Défini dans
media/client.ts:591
▸ getAnalytics(mediaKeys, endTime, startTime, granularity, options): Promise<Response>
Obtenir les statistiques des médias
Récupère les données d’analyse pour les médias.
| Name | Type | Description |
|---|
mediaKeys | any[] | Une liste de Media Keys séparées par des virgules. Jusqu’à 100 sont autorisées par requête. |
endTime | string | YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC représentant la fin de l’intervalle de temps. |
startTime | string | YYYY-MM-DDTHH:mm:ssZ. L’horodatage UTC représentant le début de l’intervalle de temps. |
granularity | string | La granularité des résultats de comptage de la recherche. |
options | GetAnalyticsOptions & { requestOptions: { raw: true } } | - |
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou la Response brute si requestOptions.raw vaut true
Défini dans
media/client.ts:699
▸ getAnalytics(mediaKeys, endTime, startTime, granularity, options?): Promise<MediaAnalytics>
| Nom | Type |
|---|
mediaKeys | any[] |
endTime | string |
startTime | string |
granularity | string |
options? | GetAnalyticsOptions |
Renvoie
Promise<MediaAnalytics>
Défini dans
media/client.ts:724
▸ appendUpload(id, options): Promise<Response>
Ajouter à un téléversement de média
Ajoute des données à une requête de téléversement de média.
| Nom | Type | Description |
|---|
id | string | Identifiant du média pour lequel exécuter l’opération d’ajout. |
options | AppendUploadOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou la Response brute si requestOptions.raw est true
Défini dans
media/client.ts:918
▸ appendUpload(id, options?): Promise<MediaUploadAppendResponse>
| Nom | Type |
|---|
id | string |
options? | AppendUploadOptions |
Renvoie
Promise<MediaUploadAppendResponse>
media/client.ts:931
▸ getByKeys(mediaKeys, options): Promise<Response>
Obtenir des médias par clés de média
Récupère les détails des fichiers média à partir de leurs clés de média.
| Nom | Type | Description |
|---|
mediaKeys | any[] | Une liste de Media Keys séparées par des virgules. Jusqu’à 100 peuvent être fournies dans une seule requête. |
options | GetByKeysOptions & { requestOptions: { raw: true } } | - |
Renvoie
Promise<Response>
Promesse qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true
Défini dans
media/client.ts:1039
▸ getByKeys(mediaKeys, options?): Promise<Get2MediaResponse>
| Nom | Type |
|---|
mediaKeys | any[] |
options? | GetByKeysOptions |
Renvoie
Promise<Get2MediaResponse>
Défini dans
media/client.ts:1052
▸ createMetadata(options): Promise<Response>
Créer les métadonnées d’un média
Crée les métadonnées d’un fichier média.
| Nom | Type |
|---|
options | CreateMetadataOptions & { requestOptions: { raw: true } } |
Renvoie
Promise<Response>
Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true
Défini dans
media/client.ts:1191
▸ createMetadata(options?): Promise<MetadataCreateResponse>
| Nom | Type |
|---|
options? | CreateMetadataOptions |
Renvoie
Promise<MetadataCreateResponse>
Défini dans
media/client.ts:1200
▸ finalizeUpload(id, options): Promise<Response>
Finaliser le téléversement de médias
Finalise une requête de téléversement de médias.
| Nom | Type | Description |
|---|
id | string | L’id du média ciblé à finaliser. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Renvoie
Promise<Response>
Promise qui se résout en la réponse de l’API, ou en l’objet Response brut si requestOptions.raw est défini sur true
Défini dans
media/client.ts:1296
▸ finalizeUpload(id): Promise<MediaUploadResponse>
Renvoie
Promise<MediaUploadResponse>
Défini dans
media/client.ts:1309
▸ initializeUpload(options): Promise<Response>
Initialiser le téléversement de médias
Initialise un téléversement de médias.
| Nom | Type |
|---|
options | InitializeUploadOptions & { requestOptions: { raw: true } } |
Renvoie
Promise<Response>
Promise se résolvant avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true
Défini dans
media/client.ts:1396
▸ initializeUpload(options?): Promise<MediaUploadResponse>
| Nom | Type |
|---|
options? | InitializeUploadOptions |
Renvoie
Promise<MediaUploadResponse>
Défini dans
media/client.ts:1405
▸ createSubtitles(options): Promise<Response>
Créer des sous-titres Media
Crée des sous-titres pour un fichier Media donné.
| Nom | Type |
|---|
options | CreateSubtitlesOptions & { requestOptions: { raw: true } } |
Renvoie
Promise<Response>
Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true
Défini dans
media/client.ts:1497
▸ createSubtitles(options?): Promise<SubtitlesCreateResponse>
| Nom | Type |
|---|
options? | CreateSubtitlesOptions |
Renvoie
Promise<SubtitlesCreateResponse>
media/client.ts:1506
▸ deleteSubtitles(options): Promise<Response>
Supprimer les sous-titres Media
Supprime les sous-titres d’un fichier Media donné.
| Nom | Type |
|---|
options | DeleteSubtitlesOptions & { requestOptions: { raw: true } } |
Renvoie
Promise<Response>
Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true
Défini dans
media/client.ts:1598
▸ deleteSubtitles(options?): Promise<SubtitlesDeleteResponse>
| Nom | Type |
|---|
options? | DeleteSubtitlesOptions |
Renvoie
Promise<SubtitlesDeleteResponse>
Défini dans
media/client.ts:1607
