Class Session.Capabilities

  • Enclosing class:
    Session

    public static class Session.Capabilities
    extends java.lang.Object
    Defines the value returned by the Session.getCapabilities() method. After you have connected to a session and the Session.SessionListener.onConnected(Session session) method has been called, this property identifies whether the client can publish streams, subscribe to streams, and use the methods to mute the audio of streams in a session, based on the role assigned to the token used to connect to the session.

    For example, if you connect to a session using a token that is assigned a Subscriber role, the canPublish property of this object is set to false (and the client does not have privileges to publish to the session). For more information, see the OpenTok token documentation.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      boolean canForceMute
      Whether the client can request force mute streams in the session or disable the active mute state in a session (true) or not (false).
      boolean canPublish
      Whether the client can publish streams to the session (true) or not (false).
      boolean canSubscribe
      Whether the client can subscribe to streams in the session (true) or not (false).
    • Constructor Summary

      Constructors 
      Constructor Description
      Capabilities()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • canPublish

        public boolean canPublish
        Whether the client can publish streams to the session (true) or not (false). This is set to false for clients that connect to a session using a token that is assigned a Subscriber role.
      • canSubscribe

        public boolean canSubscribe
        Whether the client can subscribe to streams in the session (true) or not (false). This is set to true for all clients (since all tokens allow clients to subscribe to streams).
    • Constructor Detail

      • Capabilities

        public Capabilities()
    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object