Enum ClientTrackSwitchOffControl

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ClientTrackSwitchOffControl>

    public enum ClientTrackSwitchOffControl
    extends java.lang.Enum<ClientTrackSwitchOffControl>
    Configures the mode for switching off/on subscribed RemoteVideoTracks based on the subscriber's rendering environment. Switching off a RemoteVideoTrack means no media is sent by the media server to the client for that track even though it has been subscribed to by the client. This feature helps in conserving network bandwidth and CPU resources by avoiding unnecessary transmission and decoding of remote tracks. This feature supersedes the `maxTracks` parameter. Attempting to set `clientTrackSwitchOffControl` when `maxTracks` is already set will throw an exception.
    • Method Detail

      • values

        public static ClientTrackSwitchOffControl[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ClientTrackSwitchOffControl c : ClientTrackSwitchOffControl.values())
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ClientTrackSwitchOffControl valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        name - the name of the enum constant to be returned.
        the enum constant with the specified name
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null