Hérite de : : Object

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

Vue d'ensemble

Représente l'archive d'une session OpenTok.

"1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait).
 You may want to use a portrait aspect ratio for archives that include video streams from mobile devices (which often use the portrait aspect ratio).
 This property is only set for composed archives.

Résumé des attributs d'instance

Résumé des méthodes d'instance

Gestion dynamique des méthodes

Cette classe gère les méthodes dynamiques via la méthode `method_missing`

#méthode_manquante(méthode, *args, &block) ⇒ Objet

Détails des attributs d'instance

#created_at ⇒ int

L'heure à laquelle l'archive a été créée, exprimée en millisecondes depuis l'époque UNIX.

Retours :

  • (int) —

    la valeur actuelle de « created_at »

#durée ⇒ chaîne de caractères

La durée de conservation de l'archive, en secondes.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de la durée

#has_audio ⇒ vrai, faux

Indique si le fichier d'archive comporte une piste audio (vrai) ou non (faux).

Retours :

  • (vrai, faux) —

    la valeur actuelle de has_audio

#has_video ⇒ vrai, faux

Si l'archive contient une piste vidéo (vrai) ou non (faux).

Retours :

  • (vrai, faux) —

    la valeur actuelle de has_video

#id ⇒ chaîne de caractères

L'identifiant de l'archive.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de l'identifiant

#multi_archive_tag ⇒ Objet (en lecture seule)

Renvoie la valeur de l'attribut « multi_archive_tag ».

#nom ⇒ chaîne de caractères

Nom de l'archive. Si aucun nom n'a été spécifié lors de la création de l'archive, cette valeur est définie sur null.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de « nom »

#mode_de_sortie ⇒ Chaîne de caractères

Est-ce que tous les flux de l'archive sont enregistrés dans un seul fichier (:composed) ou à des fichiers individuels (:individual).

Retours :

  • (Chaîne de caractères) —

    la valeur actuelle de output_mode

#projectId ⇒ chaîne de caractères

La clé API associée à l'archive.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de projectId

#raison ⇒ chaîne de caractères

Pour les archives dont le statut est « interrompue » ou « échouée », cette chaîne de caractères décrit la raison pour laquelle l'archivage a été interrompu (par exemple, « durée maximale dépassée ») ou a échoué.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de la raison

#résolution ⇒ chaîne de caractères

La résolution de l'archive, soit « 640x480 » (SD en mode paysage, par défaut), soit « 1280x720 » (HD en mode paysage),

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de la résolution

#session_id ⇒ chaîne de caractères

L'identifiant de la session OpenTok associée à cette archive.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de session_id

#taille ⇒ float

La taille du fichier MP4. Pour les archives qui n'ont pas encore été générées, cette valeur est définie sur 0.

Retours :

  • (float) —

    la valeur actuelle de « size »

#statut ⇒ chaîne de caractères

Le statut de l'archive, qui peut être l'un des suivants :

  • « disponible » – L'archive est disponible au téléchargement depuis le cloud OpenTok.
  • « expiré » – L'archive n'est plus disponible au téléchargement depuis le cloud OpenTok.
  • « Échec » – L'archivage de l'enregistrement a échoué.
  • « en pause » – L’archivage est en cours et aucun client ne publie de flux vers la session. Lorsqu’un archivage est en cours et qu’un client publie un flux, le statut passe à « démarré ». Lorsqu’un archivage est en pause, rien n’est enregistré. Lorsqu’un client commence à publier un flux, l’enregistrement démarre (ou reprend). Si tous les clients se déconnectent d’une session en cours d’archivage, le statut passe à « en pause », et après 60 secondes, l’enregistrement d’archivage s’arrête (et le statut passe à « arrêté »).
  • « a commencé » – L'archivage a commencé et l'enregistrement est en cours.
  • « arrêté » – L'archive a cessé l'enregistrement.
  • « mis en ligne » – L'archive est disponible au téléchargement depuis le compartiment Amazon S3 ou le conteneur Windows Azure de destination que vous avez défini pour votre Projet OpenTok.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle du statut

#mode_flux ⇒ Objet (en lecture seule)

Renvoie la valeur de l'attribut stream_mode.

#streamMode ⇒ chaîne de caractères

Si les flux inclus dans les archives sont sélectionnés automatiquement (« auto », par défaut) ou manuellement (« manual »).

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de streamMode

#url ⇒ chaîne de caractères

L'URL de téléchargement du fichier MP4 disponible. Cette propriété n'est définie que pour les archives dont le statut est « disponible » ; pour les autres archives (y compris celles dont le statut est « téléchargé »), cette propriété est définie sur null. L'URL de téléchargement est masquée, et le fichier n'est accessible via cette URL que pendant 10 minutes. Pour générer une nouvelle URL, appelez la méthode Archive.listArchives() ou OpenTok.getArchive().

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de l'URL

Détails de la méthode d'instance

#add_stream(stream_id, opts = {}) ⇒ 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 :

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

    L'identifiant du flux à ajouter à l'archive

  • opts (Table de hachage) (valeur par défaut : {}) —

    un ensemble d'options personnalisables

Table de hachage des options (opts) :

  • :has_audio (true, false)

    — par défaut : Booléen, facultatif —

    — Indique si l'archive générée doit inclure le flux audio (true, valeur par défaut) ou non (false).

  • :has_video (vrai, faux)

    — par défaut : Booléen, facultatif —

    — Indique si l'archive générée doit inclure la vidéo du flux (true, valeur par défaut) ou non (false).

Augmentations :

  • (OpenTokArchiveError) —

    Le paramètre « streamMode » de l'archive n'est pas défini sur « manual ».

#supprimer ⇒ Objet

Supprime une archive OpenTok.

Vous ne pouvez supprimer qu'une archive dont le statut est « disponible » ou « téléchargée ». La suppression d'une archive entraîne la suppression de son entrée de la liste des archives. Pour une archive « disponible », cela entraîne également la suppression du fichier d'archive, qui ne sera alors plus disponible au téléchargement.

#mise en page(opts = {}) ⇒ 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 :

  • options (Hash) —

    un ensemble d'options personnalisables

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(stream_id) ⇒ Objet

Supprime un flux de l'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 :

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

    L'identifiant du flux à supprimer de l'archive

Augmentations :

  • (OpenTokArchiveError) —

    Le paramètre « streamMode » de l'archive n'est pas défini sur « manual ».

#arrêter ⇒ Objet

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.

#to_json ⇒ Objet

Une représentation sous forme de chaîne de caractères, encodée au format JSON, de l'archive.