com.opentok.android.SubscriberKit
Toutes les interfaces implémentées :
: Observer
Sous-classes directes connues :
: Subscriber
classe publique SubscriberKit hérite de Objet outils Observateur
Un objet SubscriberKit (abonné) affiche les données multimédias associées à un flux
La classe SubscriberKit vous permet de définir un moteur de rendu vidéo personnalisé pour le flux vidéo.
Créez une sous-classe de SubscriberKit si vous souhaitez fournir votre propre
implémentation de traitement et de rendu vidéo. Sinon, utilisez le Subscriber classe,
qui intègre un processeur vidéo et un moteur de rendu prêts à l'emploi.
La propriété « stream » fait référence au flux auquel vous êtes abonné. La classe SubscriberKit comprend des méthodes qui vous permettent de désactiver et d'activer la lecture locale de l'audio et de la vidéo pour le flux auquel vous êtes abonné.
Résumé des classes imbriquées
Classes imbriquées
Modificateur et type
Classe
Description
static interface
SubscriberKit.AudioLevelListener
Surveille les variations du niveau audio de l'abonné.
static interface
SubscriberKit.AudioStatsListener
Définit l'objet « listener » permettant d'obtenir les statistiques audio des abonnés.
static class
SubscriberKit.Builder
Sert à créer un SubscriberKit objet.
static interface
SubscriberKit.CaptionsListener
Un écouteur pour le texte des sous-titres mis à jour.
static interface
SubscriberKit.MediaLinkStatsListener
Définit l'objet d'écoute permettant d'obtenir les statistiques relatives aux liens multimédias des abonnés, y compris les indicateurs au niveau du transport et les changements d'état du réseau.
static class
SubscriberKit.SenderStats
Représente les statistiques vidéo communiquées par l'expéditeur, telles que les estimations de débit binaire.
static interface
SubscriberKit.StreamListener
Surveille les moments où le flux de l'abonné est interrompu et reprend.
static class
SubscriberKit.SubscriberAudioStats
Définit les statistiques audio d'un abonné.
static interface
SubscriberKit.SubscriberListener
Surveille les changements d'état d'un SubscriberKit instance.
static class
SubscriberKit.SubscriberMediaLinkStats
Fournit des statistiques sur les liaisons réseau des abonnés, notamment des indicateurs de transport locaux et distants ainsi que des informations sur la dégradation du réseau.
static interface
SubscriberKit.SubscriberRtcStatsReportListener
Définit l'objet d'écoute permettant de récupérer les rapports statistiques RTC des abonnés.
static class
SubscriberKit.SubscriberVideoStats
Définit les statistiques vidéo d'un abonné.
static interface
SubscriberKit.VideoListener
Surveille le moment où l'abonné commence et cesse de recevoir des données vidéo.
static interface
SubscriberKit.VideoStatsListener
Définit l'objet d'écoute permettant d'obtenir les statistiques vidéo des abonnés.
Résumé du champ
Champs
Modificateur et type
Champ d'application
Description
protected SubscriberKit.AudioLevelListener
audioLevelListener
protected SubscriberKit.AudioStatsListener
audioStatsListener
protected SubscriberKit.CaptionsListener
captionsListener
protected SubscriberKit.MediaLinkStatsListener
mediaLinkStatsListener
static final String
NETWORK_REASON_NETWORK_CONDITION_CHANGE
Indique que l'état du réseau du participant local ou distant a changé.
static final float
NO_PREFERRED_FRAMERATE
Définit une valeur de réinitialisation à transmettre à la fonction setPreferredFrameRate(float preferredFrameRate) méthode.
static final VideoUtils.Size
NO_PREFERRED_RESOLUTION
Définit une valeur de réinitialisation à transmettre à la fonction setPreferredResolution(VideoUtils.Size preferredResolution)
méthode.
protected BaseVideoRenderer
renderer
protected SubscriberKit.SubscriberRtcStatsReportListener
rtcStatsReportListener
protected Session
session
protected Stream
stream
protected SubscriberKit.StreamListener
streamListener
protected SubscriberKit.SubscriberListener
subscriberListener
static final String
VIDEO_REASON_CODEC_CHANGE
Le codec vidéo utilisé pour le flux a changé.
static final String
VIDEO_REASON_CODEC_NOT_SUPPORTED
Ce problème vidéo s'est produit lorsque la vidéo du flux de l'abonné a été désactivée, car ce flux utilise un codec vidéo (tel que H.264) non pris en charge par l'appareil.
static final String
VIDEO_REASON_INTERRUPTION
La diffusion vidéo a été interrompue.
static final String
VIDEO_REASON_NONE
static final String
VIDEO_REASON_PUBLISH_VIDEO
Cet événement vidéo a été déclenché par le fait que l'éditeur du flux a lancé ou arrêté le flux vidéo.
static final String
VIDEO_REASON_QUALITY
Ce problème vidéo a été provoqué par une modification de la qualité du flux vidéo.
static final String
VIDEO_REASON_RESOLUTION_CHANGE
La résolution de la diffusion a changé.
static final String
VIDEO_REASON_SUBSCRIBE_TO_VIDEO
Cet incident vidéo a été provoqué par un appel vers la
setSubscribeToVideo(boolean subscribeToVideo)
méthode.
protected SubscriberKit.VideoListener
videoListener
protected SubscriberKit.VideoStatsListener
videoStatsListener
Résumé du constructeur
Constructeurs
Modificateur
Constructeur
Description
protected
SubscriberKit(SubscriberKit.Builder builder)
Résumé de la méthode
Toutes les méthodes · Méthodes d'instance · Méthodes concrètes · Méthodes obsolètes
Modificateur et type
Méthode
Description
protected void
attachToSession(Session session)
void
destroy()
Obsolète.
protected void
detachFromSession(Session session)
protected void
finalize()
Appelée par le ramasse-miettes sur un objet `SubscriberKit` lorsque le ramasse-miettes détermine qu'il n'y a plus aucune référence à cet objet.
double
getAudioVolume()
Renvoie le volume audio de l'abonné, compris entre 0 et 100.
String
getCaptionsTranslationLanguage()
Récupère la langue de traduction des sous-titres configurée pour cet abonné.
float
getPreferredFrameRate()
Renvoie la fréquence d'images souhaitée pour le flux de l'abonné.
VideoUtils.Size
getPreferredResolution()
Renvoie la résolution préférée pour le flux de l'abonné.
BaseVideoRenderer
getRenderer()
Renvoie le moteur de rendu vidéo associé à cet abonné.
void
getRtcStatsReport()
Récupère le rapport statistique RTC de l'abonné.
Session
getSession()
Renvoie le Session que l'abonné est tenu de respecter (en appelant
le connect() méthode de l'objet Session).
Stream
getStream()
Renvoie le Stream à laquelle cette instance est associée.
boolean
getSubscribeToAudio()
Que l'abonné soit abonné au contenu audio ou non.
boolean
getSubscribeToCaptions()
Que l'abonné soit abonné ou non aux sous-titres.
boolean
getSubscribeToVideo()
Que l'abonné soit abonné au contenu audio ou non.
android.view.View
getView()
Renvoie l'objet `android.view.View` contenant la vidéo du souscripteur.
protected void
onAudioDisabled()
Appelée lorsque le flux audio de l'abonné a été désactivé
protected void
onAudioEnabled()
Appelée lorsque le flux de l'abonné est activé pour l'audio.
protected void
onAudioLevelUpdated(float audioLevel)
protected void
onCaptionText(String text, boolean isFinal)
protected void
onConnected()
Appelée lorsque l'instance s'est connectée avec succès au flux et commence la lecture du contenu multimédia.
protected void
onDisconnected()
Obsolète.
protected void
onError(OpentokError error)
Cet événement est déclenché lorsqu'un abonné n'a pas réussi à se connecter au serveur OpenTok.
void
onPause()
N'appelez pas directement ; appelez Session.onPause() au lieu de cela.
void
onResume()
N'appelez pas directement ; appelez Session.onResume() au lieu de cela.
protected void
onRtcStatsReport(String jsonArrayOfReports)
Appelée lorsque le rapport statistique RTC de l'abonné est disponible en réponse à un
appel vers getRtcStatsReport().
protected void
onStreamDisconnected()
Appelée lorsque le flux de l'abonné a été interrompu.
protected void
onStreamReconnected()
Appelée lorsque le flux de l'abonné a repris, après la
onStreamDisconnected() est appelée.
protected void
onVideoDataReceived()
Appelée lorsqu'un abonné reçoit des données vidéo pour la première fois.
protected void
onVideoDisabled(String reason)
Appelée lorsque l'abonné ne reçoit plus de flux vidéo.
protected void
onVideoDisableWarning()
Appelée lorsque le routeur multimédia OpenTok détecte que la qualité du flux s'est dégradée et que la vidéo sera désactivée si la qualité continue de se dégrader.
protected void
onVideoDisableWarningLifted()
Appelée lorsque le routeur multimédia OpenTok détermine que la qualité du flux s'est améliorée au point que la désactivation de la vidéo ne présente plus de risque immédiat.
protected void
onVideoEnabled(String reason)
Appelée lorsque le flux vidéo de l'abonné démarre (alors qu'il n'y avait auparavant pas de vidéo) ou reprend (après une interruption de la vidéo).
void
setAudioLevelListener(SubscriberKit.AudioLevelListener listener)
Lie un SubscriberKit.AudioLevelListener à cette instance de SubscriberKit afin de surveiller les
mises à jour du niveau audio.
void
setAudioStatsListener(SubscriberKit.AudioStatsListener listener)
Configure un écouteur pour les statistiques audio des abonnés.
void
setAudioVolume(double volume)
Permet de régler le volume audio de l'abonné, entre 0 et 100.
void
setCaptionsListener(SubscriberKit.CaptionsListener listener)
Lie un SubscriberKit.CaptionsListener à cette instance de SubscriberKit pour recevoir les sous-titres.
void
setCaptionsTranslationLanguage(String language)
Définit la langue de traduction des sous-titres préférée pour cet abonné.
void
setMediaLinkStatsListener(SubscriberKit.MediaLinkStatsListener listener)
Configure un écouteur pour les statistiques relatives aux liens multimédias des abonnés.
void
setPreferredFrameRate(float preferredFrameRate)
Définit la fréquence d'images souhaitée pour le flux de l'abonné.
void
setPreferredResolution(VideoUtils.Size preferredResolution)
Définit la résolution préférée pour le flux de l'abonné.
void
setRenderer(BaseVideoRenderer renderer)
Obsolète.
void
setRtcStatsReportListener(SubscriberKit.SubscriberRtcStatsReportListener listener)
Définit le récepteur de rapports statistiques RTC pour l'abonné.
void
setStreamListener(SubscriberKit.StreamListener listener)
Configure un écouteur pour les événements liés à l'interruption et à la reprise du flux de l'abonné.
void
setStyle(String key, String value)
Définir un style utilisé par cet abonné.
void
setSubscriberListener(SubscriberKit.SubscriberListener listener)
Définit un SubscriberKit.SubscriberListener objet permettant de surveiller les changements d'état.
void
setSubscribeToAudio(boolean subscribeToAudio)
Faut-il s'abonner au flux audio (true) ou non (false).
void
setSubscribeToCaptions(boolean subscribeToCaptions)
Faut-il s'abonner aux sous-titres de la vidéo (true) ou non (false)..
void
setSubscribeToVideo(boolean subscribeToVideo)
Faut-il s'abonner à la chaîne vidéo (true) ou non (false).
void
setVideoListener(SubscriberKit.VideoListener listener)
Définit un SubscriberKit.VideoListener objet permettant de surveiller le moment où l'abonné commence
et cesse de recevoir la vidéo.
void
setVideoStatsListener(SubscriberKit.VideoStatsListener listener)
Configure un écouteur pour les statistiques vidéo des abonnés.
void
update(Observable o, Object arg)
Obsolète.
Méthodes héritées de la classe java.lang.Objet
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Détails du champ
VIDÉO_RAISON_AUCUNE
public static final Chaîne VIDÉO_RAISON_AUCUNE
Voir aussi : : - [Valeurs de champ constantes]
VIDÉO_MOTIF_PUBLICATION_VIDÉO
public static final Chaîne VIDÉO_MOTIF_PUBLICATION_VIDÉO
Cet événement vidéo a été déclenché par le diffuseur qui a lancé ou arrêté le flux vidéo. Cette chaîne correspond à la valeur de la propriété « reason » de l'objet
Voir aussi :
: - method.
- method.
- [Valeurs de champ constantes]
VIDÉO_RAISON_DE_S'ABONNER_À_LA_VIDÉO
public static final Chaîne VIDÉO_RAISON_DE_S'ABONNER_À_LA_VIDÉO
Cet incident vidéo a été provoqué par un appel vers la
setSubscribeToVideo(boolean subscribeToVideo)
méthode.
Voir aussi :
: - SubscriberKit.VideoListener.onVideoDisabled(SubscriberKit, String)
- SubscriberKit.VideoListener.onVideoEnabled(SubscriberKit, String)
- [Valeurs de champ constantes]
VIDÉO_RAISON_QUALITÉ
public static final Chaîne VIDÉO_RAISON_QUALITÉ
Ce problème vidéo a été provoqué par une modification de la qualité du flux vidéo. La qualité du flux peut varier en fonction des conditions du réseau ou de l'utilisation du processeur, que ce soit du côté de l'abonné ou de celui de l'éditeur.
Lorsqu'elle est activée, la fonction de repli audio déclenche un événement lorsque l'abonné
perd le flux vidéo en raison d'une dégradation de la qualité vidéo, ce qui entraîne la
SubscriberKit.VideoListener.onVideoDisabled(SubscriberKit, String) méthode en cours d’
appel.
Lorsque les conditions s’améliorent, le flux vidéo reprend, et le
SubscriberKit.VideoListener.onVideoEnabled(SubscriberKit, String) La méthode est
appelée.
En cas d'interruption du flux vidéo, l'abonné continue de recevoir le flux audio, le cas échéant.
Dans les sessions acheminées, la source de cet événement peut être le Vonage Video
Media Router (repli audio de l'abonné) ou le client éditeur
(repli audio de l'éditeur). Lorsque la source est le client éditeur,
l'événement est suivi d'un
Session.StreamPropertiesListener.onStreamHasVideoChanged(Session, Stream, boolean)
appel de retour déclenché par l'objet de session, indiquant que le
canal vidéo auquel l'abonné est abonné n'est plus actif. En général, cet
événement supplémentaire signale une dégradation du réseau du côté de l'éditeur ; toutefois,
les métriques communiquées par l'abonné peuvent influencer les décisions de repli de l'éditeur,
ce qui peut compliquer l'identification de la source exacte de la dégradation.
Dans les sessions relayées, l’événement « quality » est déclenché exclusivement en raison de la logique interne de repli audio de l’éditeur (Publisher Audio Fallback). Cet événement n’est suivi d’aucun rappel indiquant que la vidéo est inactive, car le flux peut toujours être reçu par d’autres abonnés bénéficiant de meilleures conditions réseau. Notez que dans les sessions relayées, bien que les événements de repli audio proviennent de l’éditeur, une dégradation du réseau peut se produire aussi bien du côté de l’éditeur que de celui de l’abonné.
Voir aussi :
: - method.
- method.
- [Valeurs de champ constantes]
VIDÉO_MOTIF_CODEC_NON_PRIS_EN_CHARGE
public static final Chaîne VIDÉO_MOTIF_CODEC_NON_PRIS_EN_CHARGE
Ce problème vidéo s'est produit lorsque la vidéo du flux de l'abonné a été désactivée, car ce flux utilise un codec vidéo (tel que H.264) non pris en charge par l'appareil.
Voir aussi : : - [Valeurs de champ constantes]
VIDÉO_MOTIF_D'INTERRUPTION
public static final Chaîne VIDÉO_MOTIF_D'INTERRUPTION
La diffusion vidéo a été interrompue.
Voir aussi : : - [Valeurs de champ constantes]
VIDÉO_MOTIF_MODIFICATION_DE_LA_RÉSOLUTION
public static final Chaîne VIDÉO_MOTIF_MODIFICATION_DE_LA_RÉSOLUTION
La résolution de la diffusion a changé.
Voir aussi : : - [Valeurs de champ constantes]
VIDÉO_RAISON_CHANGEMENT_DE_CODEC
public static final Chaîne VIDÉO_RAISON_CHANGEMENT_DE_CODEC
Le codec vidéo utilisé pour le flux a changé.
Voir aussi : : - [Valeurs de champ constantes]
NETWORK_REASON_NETWORK_CONDITION_CHANGE
public static final Chaîne NETWORK_REASON_NETWORK_CONDITION_CHANGE
Indique que l'état du réseau du participant local ou distant a changé. Cet événement est déclenché lorsqu'un changement significatif est détecté dans l' état du réseau de l'éditeur ou de l'abonné.
Voir aussi : : - [Valeurs de champ constantes]
NO_PREFERRED_RESOLUTION
public static final VideoUtils.Size NO_PREFERRED_RESOLUTION
Définit une valeur de réinitialisation à transmettre à la fonction setPreferredResolution(VideoUtils.Size preferredResolution)
méthode. Transmettez cette valeur pour réinitialiser l'abonné afin qu'il n'ait plus de résolution préférée.
L'abonné utilisera alors la résolution maximale disponible, en fonction des conditions.
Cela ne s'applique qu'aux flux publiés à l'aide de la fonctionnalité de vidéo évolutive .
NO_PREFERRED_FRAMERATE
public static final float NO_PREFERRED_FRAMERATE
Définit une valeur de réinitialisation à transmettre à la fonction setPreferredFrameRate(float preferredFrameRate) méthode. Transmettez
cette valeur pour réinitialiser l'abonné afin qu'il n'ait plus de fréquence d'images préférée. L'abonné
utilisera alors la fréquence d'images maximale disponible, en fonction des conditions.
Cela ne s'applique qu'aux flux publiés à l'aide de la fonctionnalité de vidéo évolutive.
Voir aussi : : - [Valeurs de champ constantes]
videoStatsListener
protégé SubscriberKit.VideoStatsListener videoStatsListener
audioStatsListener
protégé SubscriberKit.AudioStatsListener audioStatsListener
mediaLinkStatsListener
protégé SubscriberKit.MediaLinkStatsListener mediaLinkStatsListener
subscriberListener
protégé SubscriberKit.SubscriberListener subscriberListener
rtcStatsReportListener
protégé SubscriberKit.SubscriberRtcStatsReportListener rtcStatsReportListener
videoListener
protégé SubscriberKit.VideoListener videoListener
audioLevelListener
protégé SubscriberKit.AudioLevelListener audioLevelListener
captionsListener
protégé SubscriberKit.CaptionsListener captionsListener
streamListener
protégé SubscriberKit.StreamListener streamListener
session
protégé Session session
moteur de rendu
protégé BaseVideoRenderer moteur de rendu
flux
protégé Flux flux
Informations sur le constructeur
SubscriberKit
protected SubscriberKit(SubscriberKit.Builder constructeur)
Détails de la méthode
détruire
@Obsolète public void destroy()
Obsolète.
La destruction manuelle de l'objet n'est pas sans risque. À partir de la version 2.17.0, cette méthode n'a aucun effet. Les ressources seront automatiquement libérées par le ramasse-miettes.
setSubscriberListener
public void setSubscriberListener(SubscriberKit.SubscriberListener auditeur)
Définit un SubscriberKit.SubscriberListener objet permettant de surveiller les changements d'état.
Paramètres :
: listener - Le SubscriberKit.SubscriberListener qui assure la surveillance de cette instance de SubscriberKit.
setVideoListener
public void setVideoListener(SubscriberKit.VideoListener auditeur)
Définit un SubscriberKit.VideoListener objet permettant de surveiller le moment où l'abonné commence
et cesse de recevoir la vidéo.
Paramètres :
: listener - Le SubscriberKit.VideoListener instance.
setAudioLevelListener
public void setAudioLevelListener(SubscriberKit.AudioLevelListener auditeur)
Lie un SubscriberKit.AudioLevelListener à cette instance de SubscriberKit afin de surveiller les
mises à jour du niveau audio.
Paramètres :
: listener - Le SubscriberKit.AudioLevelListener qui assurera la surveillance de cette instance. Définissez
cette valeur sur null pour déconnecter un écouteur et mettre fin à la surveillance des niveaux audio.
setCaptionsListener
public void setCaptionsListener(SubscriberKit.CaptionsListener auditeur)
Lie un SubscriberKit.CaptionsListener à cette instance de SubscriberKit pour recevoir les sous-titres.
Paramètres :
: listener - Le SubscriberKit.CaptionsListener qui assurera la surveillance de cette instance. Définissez
cette valeur sur null pour déconnecter un écouteur et cesser de recevoir les sous-titres.
setAudioVolume
public void setAudioVolume(double volume)
Permet de régler le volume audio de l'abonné, entre 0 et 100. Si la valeur ne se situe pas dans cette plage, elle sera limitée à celle-ci.
Paramètres :
: volume - Le volume de l'abonné.
getAudioVolume
public double getAudioVolume()
Renvoie le volume audio de l'abonné, compris entre 0 et 100.
La valeur par défaut est 100.
setStreamListener
public void setStreamListener(SubscriberKit.StreamListener auditeur)
Configure un écouteur pour les événements liés à l'interruption et à la reprise du flux de l'abonné.
getSession
public Session getSession()
Renvoie le Session que l'abonné est tenu de respecter (en appelant
le connect() méthode de l'objet Session).
Retours :
: Le Session auxquelles l'abonné est tenu de se conformer.
getStream
public Flux getStream()
Renvoie le Stream à laquelle cette instance est associée.
Tous les canaux multimédias du flux doivent pouvoir être
affichés/lu à l'aide de cette instance.
Retours :
: Le Stream à laquelle cette instance est associée.
getSubscribeToAudio
public boolean getSubscribeToAudio()
Que l'abonné soit abonné au contenu audio ou non.
Valeurs de retour : : true si l'abonné s'abonne au flux audio ; false dans le cas contraire.
getSubscribeToVideo
public boolean getSubscribeToVideo()
Que l'abonné soit abonné au contenu audio ou non.
Valeurs de retour : : true si l'abonné s'abonne au flux audio ; false dans le cas contraire.
getSubscribeToCaptions
public boolean getSubscribeToCaptions()
Que l'abonné soit abonné ou non aux sous-titres.
Retourne :
: true si l'abonné est abonné aux sous-titres ; false dans le cas contraire.
La valeur par défaut correspond à la valeur « sous-titres » de son éditeur. PublisherKit.setPublishCaptions(boolean).
setSubscribeToAudio
public void setSubscribeToAudio(boolean subscribeToAudio)
Faut-il s'abonner au flux audio (true) ou non (false).
La définition de cette propriété n'a aucun effet si le hasAudio méthode de l'objet Stream
renvoie false.
Paramètres :
: subscribeToAudio - S'il faut s'abonner au flux audio (true) ou
non (false).
setSubscribeToVideo
public void setSubscribeToVideo(boolean subscribeToVideo)
Faut-il s'abonner à la chaîne vidéo (true) ou non (false).
La définition de cette propriété n'a aucun effet si le hasVideo méthode de l'objet Stream
renvoie false.
Paramètres :
: subscribeToVideo - S'il faut s'abonner à la chaîne (true) ou
non (false).
setSubscribeToCaptions
public void setSubscribeToCaptions(boolean subscribeToCaptions)
Faut-il s'abonner aux sous-titres de la vidéo (true) ou non (false)..
Paramètres :
: subscribeToCaptions - S'il faut s'abonner aux sous-titres de la vidéo (true) ou
non (false).
setCaptionsTranslationLanguage
public void setCaptionsTranslationLanguage(Chaîne langue)
Définit la langue de traduction des sous-titres préférée pour cet abonné.
Ce paramètre ne s'applique que lorsque les sous-titres sont activés.
Sélectionnez un code de langue BCP-47 pris en charge pour recevoir des sous-titres traduits,
ou null pour désactiver la traduction. La valeur par défaut est null
(aucune traduction configurée).
Les codes de langues pris en charge sont définis dans la spécification de l'API du serveur.
Il s'agit d'une fonctionnalité en version bêta privée.
Paramètres :
: language - un code de langue BCP-47 pris en charge, ou null pour désactiver la traduction.
getCaptionsTranslationLanguage
public Chaîne getCaptionsTranslationLanguage()
Récupère la langue de traduction des sous-titres configurée pour cet abonné.
Il s'agit d'une fonctionnalité en version bêta privée.
Valeurs de retour :
: Le code de langue BCP-47 configuré, ou null si la traduction n'est pas définie.
setStyle
public void setStyle(Chaîne clé, Chaîne valeur)
Définir un style utilisé par cet abonné.
Par défaut, il n'existe qu'une seule clé de style prédéfinie :
BaseVideoRenderer.STYLE_VIDEO_SCALE. Vous pouvez attribuer une valeur à cette clé
pour définir le facteur d'échelle de la vidéo. Les valeurs suivantes sont prises en charge :
BaseVideoRenderer.STYLE_VIDEO_FILL— La vidéo est redimensionnée pour occuper toute la surface du moteur de rendu, avec un recadrage si nécessaire.BaseVideoRenderer.STYLE_VIDEO_FIT— La vidéo est redimensionnée, si nécessaire, afin que l'intégralité de la vidéo soit visible, avec des bandes noires de chaque côté (réglage par défaut).
L'appel de cette méthode revient à appeler getRenderer().setStyle(). Cependant,
si vous étendez cette classe, vous pouvez redéfinir cette méthode pour prendre en charge d'autres styles et comportements.
Paramètres :
: key - Le style à définir.
: value - La valeur à laquelle vous attribuez ce style.
setRenderer
@Obsolète public void setRenderer(BaseVideoRenderer rendu)
Obsolète.
Définissez le moteur de rendu vidéo pour cet abonné.
Cette méthode est obsolète. Utilisez plutôt
la SubscriberKit.Builder.renderer(BaseVideoRenderer renderer) méthode lors de
l'utilisation du Builder pour créer l'instance SubscriberKit.
getRenderer
public BaseVideoRenderer getRenderer()
Renvoie le moteur de rendu vidéo associé à cet abonné.
getView
public android.view.View getView()
Renvoie l'objet `android.view.View` contenant la vidéo du souscripteur.
setVideoStatsListener
public void setVideoStatsListener(SubscriberKit.VideoStatsListener auditeur)
Configure un écouteur pour les statistiques vidéo des abonnés. L'objet écouteur implémente l'interface
SubscriberKit.VideoStatsListener.onVideoStats(SubscriberKit subscriber, SubscriberKit.SubscriberVideoStats stats) méthode. Cette méthode est appelée périodiquement pour signaler
les éléments suivants :
- Nombre total de paquets vidéo perdus
- Nombre total de paquets vidéo reçus
- Nombre total d'octets de vidéo reçus
Voir aussi :
: - setAudioStatsListener(AudioStatsListener listener)
setAudioStatsListener
public void setAudioStatsListener(SubscriberKit.AudioStatsListener auditeur)
Configure un écouteur pour les statistiques audio des abonnés. L'objet écouteur implémente l'interface
SubscriberKit.AudioStatsListener.onAudioStats(SubscriberKit subscriber, SubscriberKit.SubscriberAudioStats stats) méthode. Cette méthode est appelée périodiquement pour signaler
les éléments suivants :
- Nombre total de paquets audio perdus
- Nombre total de paquets audio reçus
- Nombre total d'octets audio reçus
Voir aussi :
: - setVideoStatsListener(VideoStatsListener listener)
setMediaLinkStatsListener
public void setMediaLinkStatsListener(SubscriberKit.MediaLinkStatsListener auditeur)
Configure un écouteur pour les statistiques relatives aux liens multimédias des abonnés. L'objet écouteur
implémente l'interface SubscriberKit.MediaLinkStatsListener interface, qui comprend :
SubscriberKit.MediaLinkStatsListener.onMediaLinkStats(SubscriberKit, SubscriberMediaLinkStats)— appelé périodiquement avec des indicateurs au niveau du transport.SubscriberKit.MediaLinkStatsListener.onNetworkConditionChanged(SubscriberKit, SubscriberMediaLinkStats, String)— appelée lorsque l'état du réseau change.
Paramètres :
: listener - Le SubscriberKit.MediaLinkStatsListener instance, ou null pour supprimer l'écouteur.
setPreferredResolution
public void setPreferredResolution(VideoUtils.Size (résolution_préférée)
Définit la résolution préférée pour le flux de l'abonné.
Limiter la résolution vidéo et la fréquence d'images (voir
setPreferredFrameRate(float preferredFrameRate)) réduit la charge réseau
et l'utilisation du processeur sur le client abonné. Vous pouvez choisir d'utiliser une résolution inférieure en fonction des
dimensions de la vidéo de l'abonné dans l'application. Vous pouvez également opter pour une fréquence d'images ou
une résolution inférieure pour les abonnés à un flux moins important (et de plus petite taille) que les autres
flux.
Cette méthode ne s'applique que lors de l'abonnement à un flux utilisant le fonctionnalité vidéo adaptative. La vidéo adaptative est disponible :
- Uniquement dans les sessions qui utilisent OpenTok Media Router (sessions avec le média mode sur routé).
- Uniquement pour les flux publiés par des clients prenant en charge la vidéo évolutive (voir la documentation relative à la fonctionnalité vidéo évolutive).
Dans les flux qui n'utilisent pas la vidéo adaptative, l'appel de cette méthode n'a aucun effet.
Remarque : La résolution des flux vidéo adaptatifs s'ajuste automatiquement pour chaque abonné, en fonction des conditions du réseau et de l'utilisation du processeur, même si vous n'appelez pas cette méthode. Appelez cette méthode si vous souhaitez définir une résolution maximale pour cet abonné.
Dans les flux qui n'utilisent pas la vidéo adaptative, l'appel de cette méthode n'a aucun effet.
Toutes les résolutions ne sont pas nécessairement disponibles pour un abonné. Lorsque vous définissez la résolution souhaitée,
le SDK OpenTok pour Android sélectionne la meilleure résolution disponible qui
répond à vos contraintes. Les résolutions disponibles dépendent de la largeur et de la hauteur maximales
définies par l'éditeur pour le flux, qui sont renvoyées par le
Stream.getVideoWidth() et Stream.getVideoHeight() méthodes
de l'objet Stream. Chacune des résolutions disponibles pour un flux utilisera le même
format d'image.
Entrer SubscriberKit.NO_PREFERRED_RESOLUTION pour réinitialiser l'abonné
afin qu'il n'ait plus de résolution préférée. L'abonné utilisera alors la résolution maximale
disponible, en fonction des conditions.
setPreferredFrameRate
public void setPreferredFrameRate(float preferredFrameRate)
Définit la fréquence d'images souhaitée pour le flux de l'abonné.
Limiter la fréquence d'images et la résolution vidéo (voir
setPreferredResolution(VideoUtils.Size preferredResolution))
réduit la charge réseau et
la charge CPU sur le client abonné. Vous pouvez choisir d'utiliser une résolution inférieure en fonction des
dimensions de la vidéo de l'abonné dans l'application. Vous pouvez également opter pour une fréquence d'images ou
une résolution inférieure pour les abonnés à un flux moins important (et plus petit) que les autres
flux.
Cette méthode ne s'applique que lors de l'abonnement à un flux utilisant le fonctionnalité vidéo adaptative. La vidéo adaptative est disponible :
- Uniquement dans les sessions qui utilisent OpenTok Media Router (sessions avec le média mode sur routé).
- Uniquement pour les flux publiés par des clients prenant en charge la vidéo évolutive (voir la documentation relative à la fonctionnalité vidéo évolutive).
Dans les flux qui n'utilisent pas la vidéo adaptative, l'appel de cette méthode n'a aucun effet.
Remarque : La fréquence d'images des flux vidéo adaptatifs s'ajuste automatiquement pour chaque abonné, en fonction des conditions du réseau et de l'utilisation du processeur, même si vous n'appelez pas cette méthode. Appelez cette méthode si vous souhaitez définir une fréquence d'images maximale pour cet abonné.
Les fréquences d'images disponibles dépendent de la fréquence d'images maximale disponible pour le flux. Lorsque vous définissez la fréquence d'images souhaitée pour l' abonné, le SDK OpenTok pour Android sélectionne la meilleure fréquence d'images disponible qui soit la plus proche de la fréquence souhaitée, en fonction de la bande passante du client et des contraintes liées au processeur.
Les fréquences d'images réelles disponibles dépendent, de manière dynamique, des ressources réseau et CPU mises à la disposition de l'éditeur.
Entrer SubscriberKit.NO_PREFERRED_FRAMERATE pour réinitialiser l'abonné
afin qu'il n'ait plus de fréquence d'images préférée. L'abonné utilisera alors la fréquence d'images maximale
disponible, en fonction des conditions.
getPreferredResolution
public VideoUtils.Size getPreferredResolution()
Renvoie la résolution préférée pour le flux de l'abonné. Cette méthode
ne s'applique qu'aux flux publiés à l'aide de la fonctionnalité de vidéo évolutive. Voir
setPreferredResolution(VideoUtils.Size preferredResolution).
setRtcStatsReportListener
public void setRtcStatsReportListener(SubscriberKit.SubscriberRtcStatsReportListener auditeur)
Définit le récepteur de rapports statistiques RTC pour l'abonné. Voir getRtcStatsReport().
Paramètres :
: listener - Le SubscriberKit.SubscriberRtcStatsReportListener objet.
getRtcStatsReport
public void getRtcStatsReport()
Récupère le rapport statistique RTC de l'abonné. Il s'agit d'une opération asynchrone.
Appelez la méthode SubscriberKit#setRtcStatsReportListener(SubscriberRtcStatsReportListener listener),
puis implémentez l'interface
SubscriberKit.SubscriberRtcStatsReportListener.onRtcStatsReport(SubscriberKit subscriber, String jsonArrayOfReports)
méthode avant d'appeler cette méthode. Lorsque les statistiques sont disponibles, l'implémentation
de la SubscriberKit.SubscriberRtcStatsReportListener.onRtcStatsReport(SubscriberKit subscriber, String jsonArrayOfReports)
la méthode est appelée.
Voir aussi setAudioStatsListener(SubscriberKit.AudioStatsListener listener),
setVideoStatsListener(SubscriberKit.VideoStatsListener listener)et
PublisherKit.getRtcStatsReport().
onRtcStatsReport
protected void onRtcStatsReport(Chaîne jsonArrayOfReports)
Appelée lorsque le rapport statistique RTC de l'abonné est disponible en réponse à un
appel vers getRtcStatsReport().
Si vous étendez la classe `SubscriberKit`, vous pouvez redéfinir cette méthode au lieu d' implémenter la méthode `onRtcStatsReport()` de l' interface `SubscriberKit.SubscriberRtcStatsReportListener`.
Voir onRtcStatsReport(String jsonArrayOfReports).
getPreferredFrameRate
public float getPreferredFrameRate()
Renvoie la fréquence d'images recommandée pour le flux de l'abonné. Cette méthode ne
s'applique qu'aux flux publiés à l'aide de la fonctionnalité de vidéo évolutive. Voir
setPreferredFrameRate(float preferredFrameRate).
Retourne : : La fréquence d'images souhaitée pour le flux de l'abonné ou -1 si une erreur s'est produite lors de la récupération de la valeur réelle.
onConnected
protected void onConnected()
Appelée lorsque l'instance s'est connectée avec succès au flux et commence la lecture du contenu multimédia.
Si vous étendez la classe `SubscriberKit`, vous pouvez redéfinir cette méthode à la place de la
onConnected() méthode de l'interface `SubscriberKit.SubscriberListener`.
onDisconnected
@Obsolète protected void onDisconnected()
Obsolète.
À partir de la version 2.17.0, cette fonction de rappel ne sera plus appelée. Lorsqu'un abonné se déconnecte de la
session, le Session.SessionListener.onStreamDropped(com.opentok.android.Session, com.opentok.android.Stream) la fonction de rappel sera appelée.
onError
protected void onError(OpentokError erreur)
Cet événement est déclenché lorsqu'un abonné n'a pas réussi à se connecter au serveur OpenTok.
Si vous étendez la classe `SubscriberKit`, vous pouvez redéfinir cette méthode à la place de la
onError() méthode de l'interface `SubscriberKit.SubscriberListener`.
Paramètres :
: error - L'erreur.
onStreamDisconnected
protected void onStreamDisconnected()
Appelée lorsque le flux de l'abonné a été interrompu.
Lorsque cette méthode est appelée, vous pouvez afficher une notification dans l'interface utilisateur pour informer l'utilisateur que le flux audio-vidéo est temporairement déconnecté et que l'application tente de se reconnecter au flux.
Si le client se reconnecte au flux, le onStreamReconnected() méthode est appelée.
Sinon, la onDisconnected() est appelée.
Si vous étendez la classe SubscriberKit, vous pouvez redéfinir cette méthode au lieu d'implémenter
la onDisconnected() méthode de l'interface SubscriberKit.StreamListener.
onStreamReconnected
protected void onStreamReconnected()
Appelée lorsque le flux de l'abonné a repris, après la
onStreamDisconnected() est appelée.
Si vous étendez la classe SubscriberKit, vous pouvez redéfinir cette méthode au lieu d'implémenter
la onReconnected() méthode de l'interface SubscriberKit.StreamListener.
onAudioEnabled
protected void onAudioEnabled()
Appelée lorsque le flux de l'abonné est activé pour l'audio.
Si vous étendez la classe SubscriberKit, vous pouvez redéfinir cette méthode au lieu d'implémenter
la onAudioEnabled() méthode de l'interface SubscriberKit.StreamListener.
onAudioDisabled
protected void onAudioDisabled()
Appelée lorsque le flux audio de l'abonné a été désactivé
Si vous étendez la classe SubscriberKit, vous pouvez redéfinir cette méthode au lieu d'implémenter
la onAudioDisabled() méthode de l'interface SubscriberKit.StreamListener.
onVideoDisabled
protected void onVideoDisabled(Chaîne raison)
Appelé lorsque l'abonné ne reçoit plus la vidéo. Vérifiez le paramètre « reason » pour connaître la raison de l'interruption de la vidéo.
Si vous étendez la classe `SubscriberKit`, vous pouvez redéfinir cette méthode à la place de la
onVideoDisabled() méthode de l'interface `SubscriberKit.SubscriberListener`.
Paramètres :
: reason - La raison pour laquelle la piste vidéo a été désactivée. Cette valeur peut
prendre l'une des valeurs suivantes :
VIDEO_REASON_PUBLISH_VIDEO
VIDEO_REASON_SUBSCRIBE_TO_VIDEO,
VIDEO_REASON_QUALITY, ou
VIDEO_REASON_CODEC_NOT_SUPPORTED.
onVideoEnabled
protected void onVideoEnabled(Chaîne raison)
Appelée lorsque le flux vidéo de l'abonné démarre (alors qu'il n'y avait auparavant pas de vidéo) ou reprend (après une interruption de la vidéo). Consultez le paramètre « reason » pour connaître la raison pour laquelle la vidéo s'est arrêtée.
Si vous étendez la classe `SubscriberKit`, vous pouvez redéfinir cette méthode à la place de la
onVideoEnabled() méthode de l'interface `SubscriberKit.SubscriberListener`.
Paramètres :
: reason - La raison pour laquelle la piste vidéo a démarré ou a repris. Cette valeur
peut prendre l'une des valeurs suivantes :
VIDEO_REASON_PUBLISH_VIDEO
VIDEO_REASON_SUBSCRIBE_TO_VIDEO, ou
VIDEO_REASON_QUALITY.
onVideoDisableWarning
protected void onVideoDisableWarning()
Appelée lorsque le routeur multimédia OpenTok détecte que la qualité du flux s'est
dégradée et que la vidéo sera désactivée si la qualité continue de se dégrader.
Si la qualité continue de se dégrader, l'abonné désactive la vidéo et le
onVideoDisabled(String reason) méthode est appelée. Si la qualité du flux
s'améliore, la onVideoDisableWarningLifted() est appelée.
Cette fonctionnalité n'est disponible que dans les sessions utilisant le routeur multimédia OpenTok (sessions dont le mode multimédia est défini sur « routed »), et non dans les sessions dont le mode multimédia est défini sur « relayed ». (Voir Le routeur multimédia OpenTok et les modes multimédia).
Cette méthode est principalement appelée lorsque la qualité de la connexion se détériore.
Si vous étendez la classe `SubscriberKit`, vous pouvez redéfinir cette méthode à la place de la
onVideoDisableWarning() méthode de l'interface SubscriberKit.SubscriberListener
.
onVideoDisableWarningLifted
protected void onVideoDisableWarningLifted()
Appelée lorsque le routeur multimédia OpenTok détermine que la qualité du flux s’est
améliorée au point que la désactivation de la vidéo ne présente plus de
risque immédiat. Cette méthode est appelée après la onVideoDisableWarning()
la méthode est appelée.
Cette fonctionnalité n'est disponible que dans les sessions utilisant OpenTok Media Router (sessions dont le mode multimédia est défini sur « routed »), et non dans les sessions dont le mode multimédia est défini sur « relayed ». (Voir Le routeur multimédia OpenTok et les modes multimédia.)
Cette méthode est principalement appelée lorsque la qualité de la connexion s'améliore.
Si vous étendez la classe `SubscriberKit`, vous pouvez redéfinir cette méthode à la place de
la onVideoDisableWarningLifted() méthode de l'
interface `SubscriberKit.SubscriberListener`.
onVideoDataReceived
protected void onVideoDataReceived()
Appelée lorsqu'un abonné reçoit des données vidéo pour la première fois.
Si vous étendez la classe `SubscriberKit`, vous pouvez redéfinir cette méthode à la place de la
onVideoDataReceived() méthode de l'interface SubscriberKit.VideoListener.
attachToSession
protected void attachToSession(Session session)
se déconnecter de la session
protected void detachFromSession(Session session)
onAudioLevelUpdated
protected void onAudioLevelUpdated(float audioLevel)
onCaptionText
protected void onCaptionText(Chaîne texte, booléen isFinal)
onPause
public void onPause()
N'appelez pas directement ; appelez Session.onPause() au lieu de cela.
onResume
public void onResume()
N'appelez pas directement ; appelez Session.onResume() au lieu de cela.
mise à jour
@Obsolète public void update(Observable o, Objet arg)
Obsolète.
Cette méthode est appelée chaque fois que l'objet observé subit une modification. Cette classe implémente l'interface Observer ; elle observe donc les événements, tels que les événements de mise en pause et de reprise de session.
Spécifié par :
: update dans l'interface Observer
Paramètres :
: o - L'objet observable.
: arg - Un argument transmis à la méthode `notifyObservers`.
finaliser
protected void finalize() throws À lancer
Appelée par le ramasse-miettes sur un objet `SubscriberKit` lorsque le ramasse-miettes détermine qu'il n'y a plus aucune référence à cet objet.
Remplacements :
: finalize en classe Object
Lancers :
: Throwable