> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# MediaClient

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)

* [initializeUpload](/fr/xdks/typescript/reference/classes/MediaClient#initializeupload)
* [createSubtitles](/fr/xdks/typescript/reference/classes/MediaClient#createsubtitles)
* [deleteSubtitles](/fr/xdks/typescript/reference/classes/MediaClient#deletesubtitles)

<div id="constructors">
  ## Constructeurs
</div>

<div id="constructor">
  ### constructeur
</div>

• **new MediaClient**(`client`): [`MediaClient`](/fr/xdks/typescript/reference/classes/MediaClient)

Crée une nouvelle instance de `MediaClient`

<div id="parameters">
  #### Paramètres
</div>

| Name     | Type                                                     | Description                                   |
| :------- | :------------------------------------------------------- | :-------------------------------------------- |
| `client` | [`Client`](/fr/xdks/typescript/reference/classes/Client) | Instance principale de `Client` pour la X API |

#### Renvoie

[`MediaClient`](/fr/xdks/typescript/reference/classes/MediaClient)

#### Défini dans

[media/client.ts:250](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L250)

<div id="methods">
  ## Méthodes
</div>

<div id="getbykey">
  ### getByKey
</div>

▸ **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.

<div id="parameters">
  #### Paramètres
</div>

| 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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L295)

▸ **getByKey**(`mediaKey`, `options?`): `Promise`\<[`Get2MediaMediaKeyResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2MediaMediaKeyResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type              |
| :--------- | :---------------- |
| `mediaKey` | `string`          |
| `options?` | `GetByKeyOptions` |

#### Renvoie

`Promise`\<[`Get2MediaMediaKeyResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2MediaMediaKeyResponse)>

#### Défini dans

[media/client.ts:308](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L308)

***

<div id="getuploadstatus">
  ### getUploadStatus
</div>

▸ **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.

<div id="parameters">
  #### Paramètres
</div>

| 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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L442)

▸ **getUploadStatus**(`mediaId`, `options?`): `Promise`\<[`MediaUploadResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                     |
| :--------- | :----------------------- |
| `mediaId`  | `string`                 |
| `options?` | `GetUploadStatusOptions` |

#### Renvoie

`Promise`\<[`MediaUploadResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

#### Défini dans

[media/client.ts:455](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L455)

***

<div id="upload">
  ### upload
</div>

▸ **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.

<div id="parameters">
  #### Paramètres
</div>

| 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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L582)

▸ **upload**(`options?`): `Promise`\<[`MediaUploadResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type            |
| :--------- | :-------------- |
| `options?` | `UploadOptions` |

#### Renvoie

`Promise`\<[`MediaUploadResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

#### Défini dans

[media/client.ts:591](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L591)

***

<div id="getanalytics">
  ### getAnalytics
</div>

▸ **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.

<div id="parameters">
  #### Paramètres
</div>

| 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`  }  } | -                                                                                           |

<div id="returns">
  #### Valeur de retour
</div>

`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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L699)

▸ **getAnalytics**(`mediaKeys`, `endTime`, `startTime`, `granularity`, `options?`): `Promise`\<[`MediaAnalytics`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaAnalytics)>

<div id="parameters">
  #### Paramètres
</div>

| Nom           | Type                  |
| :------------ | :-------------------- |
| `mediaKeys`   | `any`\[]              |
| `endTime`     | `string`              |
| `startTime`   | `string`              |
| `granularity` | `string`              |
| `options?`    | `GetAnalyticsOptions` |

#### Renvoie

`Promise`\<[`MediaAnalytics`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaAnalytics)>

#### Défini dans

[media/client.ts:724](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L724)

***

<div id="appendupload">
  ### appendUpload
</div>

▸ **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.

<div id="parameters">
  #### Paramètres
</div>

| 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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L918)

▸ **appendUpload**(`id`, `options?`): `Promise`\<[`MediaUploadAppendResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaUploadAppendResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                  |
| :--------- | :-------------------- |
| `id`       | `string`              |
| `options?` | `AppendUploadOptions` |

#### Renvoie

`Promise`\<[`MediaUploadAppendResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaUploadAppendResponse)>

<div id="defined-in">
  #### Définie dans
</div>

[media/client.ts:931](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L931)

***

<div id="getbykeys">
  ### getByKeys
</div>

▸ **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.

<div id="parameters">
  #### Paramètres
</div>

| 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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1039)

▸ **getByKeys**(`mediaKeys`, `options?`): `Promise`\<[`Get2MediaResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2MediaResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom         | Type               |
| :---------- | :----------------- |
| `mediaKeys` | `any`\[]           |
| `options?`  | `GetByKeysOptions` |

#### Renvoie

`Promise`\<[`Get2MediaResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2MediaResponse)>

#### Défini dans

[media/client.ts:1052](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1052)

***

<div id="createmetadata">
  ### createMetadata
</div>

▸ **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.

<div id="parameters">
  #### Paramètres
</div>

| 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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1191)

▸ **createMetadata**(`options?`): `Promise`\<[`MetadataCreateResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MetadataCreateResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                    |
| :--------- | :---------------------- |
| `options?` | `CreateMetadataOptions` |

#### Renvoie

`Promise`\<[`MetadataCreateResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MetadataCreateResponse)>

#### Défini dans

[media/client.ts:1200](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1200)

***

<div id="finalizeupload">
  ### finalizeUpload
</div>

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

Finaliser le téléversement de médias\
Finalise une requête de téléversement de médias.

<div id="parameters">
  #### Paramètres
</div>

| 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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1296)

▸ **finalizeUpload**(`id`): `Promise`\<[`MediaUploadResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom  | Type     |
| :--- | :------- |
| `id` | `string` |

#### Renvoie

`Promise`\<[`MediaUploadResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

#### Défini dans

[media/client.ts:1309](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1309)

***

<div id="initializeupload">
  ### initializeUpload
</div>

▸ **initializeUpload**(`options`): `Promise`\<`Response`>

Initialiser le téléversement de médias
Initialise un téléversement de médias.

<div id="parameters">
  #### Paramètres
</div>

| 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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1396)

▸ **initializeUpload**(`options?`): `Promise`\<[`MediaUploadResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                      |
| :--------- | :------------------------ |
| `options?` | `InitializeUploadOptions` |

#### Renvoie

`Promise`\<[`MediaUploadResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.MediaUploadResponse)>

#### Défini dans

[media/client.ts:1405](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1405)

***

<div id="createsubtitles">
  ### createSubtitles
</div>

▸ **createSubtitles**(`options`): `Promise`\<`Response`>

Créer des sous-titres Media\
Crée des sous-titres pour un fichier Media donné.

<div id="parameters">
  #### Paramètres
</div>

| 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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1497)

▸ **createSubtitles**(`options?`): `Promise`\<[`SubtitlesCreateResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.SubtitlesCreateResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                     |
| :--------- | :----------------------- |
| `options?` | `CreateSubtitlesOptions` |

#### Renvoie

`Promise`\<[`SubtitlesCreateResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.SubtitlesCreateResponse)>

<div id="defined-in">
  #### Définie dans
</div>

[media/client.ts:1506](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1506)

***

<div id="deletesubtitles">
  ### deleteSubtitles
</div>

▸ **deleteSubtitles**(`options`): `Promise`\<`Response`>

Supprimer les sous-titres Media
Supprime les sous-titres d’un fichier Media donné.

<div id="parameters">
  #### Paramètres
</div>

| 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](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1598)

▸ **deleteSubtitles**(`options?`): `Promise`\<[`SubtitlesDeleteResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.SubtitlesDeleteResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type                     |
| :--------- | :----------------------- |
| `options?` | `DeleteSubtitlesOptions` |

#### Renvoie

`Promise`\<[`SubtitlesDeleteResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.SubtitlesDeleteResponse)>

#### Défini dans

[media/client.ts:1607](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/media/client.ts#L1607)