Hérite de : : Object

Défini dans : : lib/opentok/archives.rb

Vue d'ensemble

Une classe permettant de manipuler les archives OpenTok.

Résumé des méthodes d'instance

Détails de la méthode d'instance

#add_stream(archive_id, stream_id, options) ⇒ Objet

Ajoute un flux à l'archive composée actuellement en cours d'exécution qui a été lancée avec le paramètre `streamMode` défini sur « manual ». Pour une description de cette fonctionnalité, voir <https://tokbox.com/developer/rest/#selecting-archive-streams>.

Vous pouvez appeler cette méthode à plusieurs reprises en passant le même identifiant de flux à `add_stream` pour activer ou désactiver l'audio ou la vidéo du flux dans l'archive. Si vous définissez à la fois `has_audio` et `has_video` sur `false`, vous obtiendrez une réponse d'erreur.

Paramètres :

  • archive_id (Chaîne de caractères) —

    L'identifiant de l'archive.

  • stream_id (Chaîne de caractères) —

    L'identifiant du flux à ajouter à l'archive

  • opts (Hash) —

    un ensemble d'options personnalisables

Augmentations :

  • (ArgumentError) —

    Le paramètre « archive_id » est vide.

  • (ArgumentError) —

    Le paramètre « stream_id » est vide.

  • (ArgumentError) —

    Les propriétés « has_audio » et « has_video » du paramètre « options » sont toutes deux définies sur « false ».

#tous(options = {}) ⇒ Liste des archives

Renvoie une ArchiveList, c'est-à-dire un tableau contenant les archives terminées et en cours de traitement, pour votre clé API.

Paramètres :

  • options (Hash) (valeur par défaut : {}) —

    Un hachage dont les clés définissent la plage d'archives à récupérer.

Table de hachage des options (options) :

  • :offset (entier)

    -

    Facultatif. Le décalage d'index de la première archive. La valeur 0 correspond au décalage de l'archive la plus récente. La valeur 1 correspond au décalage de l'archive qui a été lancée avant la plus récente. Si vous ne spécifiez pas de décalage, la valeur 0 est utilisée.

  • :count (entier)

    -

    Facultatif. Nombre d'archives à renvoyer. Le nombre maximal d'archives renvoyées est de 1 000.

  • :session_id (Chaîne de caractères)

    -

    Facultatif. L'identifiant de session auquel appartiennent les archives. Cela s'avère utile lorsqu'on répertorie plusieurs archives pour un session automatiquement archivée.

Retours :

Augmentations :

  • (ArgumentError)

#créer(session_id, options = {}) ⇒ Archives

Lance l'archivage d'une session OpenTok.

Les clients doivent être activement connectés à la session OpenTok pour que vous puissiez lancer correctement l'enregistrement d'une archive.

Vous ne pouvez enregistrer qu'une seule archive à la fois pour une session donnée. Vous ne pouvez enregistrer que les archives des sessions qui utilisent OpenTok Media Router (sessions dont le mode multimédia est défini sur « routed ») ; vous ne pouvez pas archiver les sessions dont le mode multimédia est défini sur « relayed ».

Pour plus d'informations sur l'archivage, voir la page Archivage OpenTok guide de programmation.

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de la session OpenTok à archiver.

  • options (Hash) (valeur par défaut : {}) —

    Un hachage contenant les clés « name », « has_audio », « has_video » et « output_mode ».

Table de hachage des options (options) :

  • :nom (Chaîne de caractères)

    -

    Il s'agit du nom de l'archive. Vous pouvez utiliser ce nom pour identifier l'archive. Il s'agit d'une propriété de l'objet Archive, ainsi que d'une propriété des événements liés aux archives dans les SDK clients OpenTok.

  • :has_audio (true, false)

    -

    L'archive comprendra-t-elle une piste audio (true) ou pas false). La valeur par défaut est true (une piste audio est incluse). Si vous configurez les deux has_audio et has_video à false, l'appel vers le create() Cette méthode génère une erreur.

  • :has_video (vrai, faux)

    -

    L'archive comprendra-t-elle une piste vidéo (true) ou pas false). La valeur par défaut est true (une piste vidéo est incluse). Si vous configurez les deux has_audio et has_video à false, l'appel vers le create() Cette méthode génère une erreur.

  • :multi_archive_tag (Chaîne de caractères)

    — par défaut : Facultatif —

    Définissez ce paramètre pour permettre l'enregistrement simultané de plusieurs archives pour une même session. Attribuez une chaîne unique à chaque archive simultanée d'une session en cours. Vous devez également définir cette option lorsque vous lancez manuellement une archive qui est archivés automatiquement. Notez que la balise « multiArchiveTag »value is not included in the response for the methods to [list archives](https://tokbox.com/developer/rest/#listing_archives) and [retrieve archive information](https://tokbox.com/developer/rest/#retrieve_archive_info). If you do not specify a unique`multi_archive_tag` : vous ne pouvez enregistrer qu'une seule archive à la fois pour une session donnée. Voir les archives « Simultaneous ».

  • :output_mode (Chaîne de caractères)

    -

    Est-ce que tous les flux de l'archive sont enregistrés dans un seul fichier (:composed, par défaut) ou à des fichiers spécifiques (:individual). Pour plus d'informations sur l'archivage et les formats de fichiers d'archive, consultez le Archivage OpenTok guide de programmation.

  • :résolution (Chaîne de caractères)

    -

    La résolution de l'archive peut être « 640x480 » (SD en mode paysage, valeur par défaut), « 1280x720 » (HD en mode paysage), « 1920x1080 » (FHD paysage), « 480x640 » (SD portrait), « 720x1280 » (HD portrait) ou « 1080x1920 » (FHD portrait). Cette propriété s'applique uniquement aux archives composées. Si vous définissez cette propriété et que vous définissez la propriété outputMode sur « individual », l’appel de la méthode génère une erreur.

  • :stream_mode (Chaîne de caractères)

    — par défaut : Facultatif —

    Si les flux inclus dans l'archive sont sélectionnés automatiquement (« auto », par défaut) ou manuellement (« manuel »). Lorsque les flux sont sélectionnés automatiquement (« auto »), tous les flux de la session peuvent être inclus dans l’archive. Lorsque les flux sont sélectionnés manuellement (« manual »), vous spécifiez les flux à inclure en fonction des appels à la méthode #ajouter_flux méthode. Vous pouvez préciser si l'archive doit inclure le flux audio, le flux vidéo ou les deux. Dans les archives composées, tant en mode automatique qu'en mode manuel, le compositeur d'archives inclut les flux en fonction de règles de hiérarchisation des cours d'eau. Important : cette fonctionnalité n'est actuellement disponible que dans l'environnement Standard.

  • :layout (Hash)

    -

    Indiquez ce paramètre pour définir le type de structure initiale de l'archive. Cela s'applique uniquement aux archives composées. Il s'agit d'un hachage contenant trois clés : :type, :stylesheet&lt;code&gt; and &lt;code&gt;:screenshare_type. Valeurs valides pour :type sont « bestFit » (meilleur ajustement), « custom » (personnalisé),

    "horizontalPresentation" (horizontal presentation),

    « pip » (image dans l'image) et « verticalPresentation » (affichage vertical)). Si vous spécifiez un type de mise en page « personnalisé », définissez le :stylesheet clé de la feuille de style (CSS). (Pour les autres types de mise en page, ne définissez pas la :stylesheet clé.) Valeurs valides pour :screenshare_type sont « bestFit », « pip », « verticalPresentation » et « horizontalPresentation ». Cette propriété est facultative. Si elle est spécifiée, alors le :type propriété doit doit être défini sur « bestFit ». Si vous ne spécifiez pas de type de mise en page initial, l'archive utilise le type de mise en page « bestFit ». Pour plus d'informations, consultez Personnalisation de la présentation vidéo pour les archives composées.

  • :max_bitrate (Entier)

    — par défaut : Facultatif —

    Le débit binaire vidéo maximal de l'archive, en bits par seconde. La valeur minimale est de 100 000 et la valeur maximale de 6 000 000. Cette option n'est valable que pour les archives composées. Définissez le débit binaire vidéo maximal pour contrôler la taille de l'archive composée. Ce débit binaire maximal s'applique uniquement au débit binaire vidéo. Si l'archive de sortie contient de l'audio, ces bits seront exclus de la limite.

Retours :

  • (Archives) —

    L'objet « Archive », qui comprend les propriétés définissant l'archive, notamment son identifiant.

Augmentations :

  • (OpenTokArchiveError) —

    Impossible de démarrer l'archive. La requête n'était pas valide ou la session ne comporte aucun client connecté.

  • (OpenTokAuthenticationError) —

    Échec de l'authentification lors du lancement d'une archive. Clé API non valide.

  • (OpenTokArchiveError) —

    Impossible de lancer l'archive. L'identifiant de session n'existe pas.

  • (OpenTokArchiveError) —

    Impossible de lancer l'archivage. La session est peut-être de type « peer-to-peer » ou est déjà en cours d'enregistrement.

  • (OpenTokArchiveError) —

    Impossible de lancer l'archive.

#supprimer_par_id(archive_id) ⇒ Objet

Supprime une archive OpenTok.

Vous ne pouvez supprimer qu'une archive dont le statut est « disponible », « téléchargée » ou « supprimée ». La suppression d'une archive supprime son enregistrement de la liste des archives. Pour une archive « disponible », cela supprime également le fichier d'archive, le rendant ainsi indisponible au téléchargement. Pour une archive « supprimée », celle-ci reste supprimée.

Paramètres :

  • archive_id (Chaîne de caractères) —

    L'identifiant de l'archive que vous souhaitez supprimer.

Augmentations :

  • (OpenTokAuthenticationError) —

    L'authentification a échoué ou un identifiant d'archive non valide a été fourni.

  • (OpenTokArchiveError) —

    L'archive n'a pas pu être supprimée. Son statut doit être « disponible », « supprimé » ou « téléchargé ».

  • (OpenTokArchiveError) —

    Il n'a pas été possible de supprimer l'archive.

#trouver(archive_id) ⇒ Archives

Récupère un objet Archive correspondant à l'ID d'archive indiqué.

Paramètres :

  • archive_id (Chaîne de caractères) —

    L'identifiant de l'archive.

Retours :

Augmentations :

#mise en page(archive_id, options = {}) ⇒ Objet

Définit le type de mise en page d'une archive composée. Pour plus d'informations sur les types de mise en page, voir Personnalisation de la présentation vidéo pour les archives composées.

Paramètres :

  • archive_id (Chaîne de caractères) —

    L'identifiant de l'archive.

  • options (Hash) (valeur par défaut : {}) —

    un ensemble d'options personnalisables

Table de hachage des options (options) :

  • :type (Chaîne de caractères)

    -

    Le type de mise en page. Définissez cette option sur « bestFit », « pip », « verticalPresentation », « horizontalPresentation », « focus » ou « custom ».

  • :feuille de style (Chaîne)

    -

    La feuille de style d'une mise en page personnalisée. Définissez ce paramètre si vous configurez type à "custom". Sinon, ne le définissez pas.

  • :screenshare_type (Chaîne de caractères)

    -

    Type de disposition du partage d'écran. Définissez cette option sur « bestFit », « pip », « verticalPresentation » ou « horizontalPresentation ». Si cette option est définie, alors le type Le paramètre doit être défini sur "bestFit".

Augmentations :

  • (ArgumentError) —

    Le paramètre `archive_id` ou `options` est vide. Ou bien le type « custom » a été spécifié sans option de feuille de style. Ou bien une feuille de style a été transmise pour un type autre que « custom ». Ou bien un type non valide a été transmis.

  • (OpenTokAuthenticationError) —

    Échec de l'authentification.

  • (ArgumentError) —

    Le paramètre « archive_id » ou « options » est vide.

  • (ArgumentError) —

    Le type « custom » a été spécifié sans option de feuille de style.

  • (ArgumentError) —

    Une feuille de style a été transmise pour un type autre que « custom ». Ou bien un type non valide a été transmis.

  • (ArgumentError) —

    Un type de mise en page non valide a été transmis.

  • (OpenTokError) —

    Erreur du serveur OpenTok.

  • (OpenTokArchiveError) —

    La mise en page a échoué.

#remove_stream(archive_id, stream_id) ⇒ Objet

Supprime un flux d'une archive composée en cours d'exécution qui a été lancée avec le paramètre `streamMode` défini sur « manual ». Pour une description de cette fonctionnalité, voir <https://tokbox.com/developer/rest/#selecting-archive-streams>.

Paramètres :

  • archive_id (Chaîne de caractères) —

    L'identifiant de l'archive.

  • stream_id (Chaîne de caractères) —

    L'identifiant du flux à supprimer de l'archive

Augmentations :

  • (ArgumentError) —

    Le paramètre « archive_id » est vide.

  • (ArgumentError) —

    Le paramètre « stream_id » est vide.

#stop_by_id(archive_id) ⇒ Archives

Arrête l'archivage OpenTok en cours d'enregistrement.

Les archives cessent automatiquement l'enregistrement au bout de 120 minutes ou lorsque tous les clients se sont déconnectés de la session en cours d'archivage.

Paramètres :

  • archive_id (Chaîne de caractères) —

    L'identifiant de l'archive dont vous souhaitez interrompre l'enregistrement.

Retours :

  • (Archives) —

    L'objet Archive correspondant à l'archive en cours d'arrêt.

Augmentations :