Package com.opentok

Enum ScreenShareLayoutType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ScreenShareLayoutType>
    public enum ScreenShareLayoutType
extends java.lang.Enum<ScreenShareLayoutType>
    Enumerates type values for the layout.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BESTFIT
      Represents the picture-in-picture (pip) layout type.
      HORIZONTAL
      Represents the horizontal presentation layout type.
      PIP
      Represents the picture-in-picture (pip) layout type.
      VERTICAL
      Represents the vertical presentation layout type.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()  
      static ScreenShareLayoutType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ScreenShareLayoutType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • PIP

        public static final ScreenShareLayoutType PIP
        Represents the picture-in-picture (pip) layout type.

      • BESTFIT

        public static final ScreenShareLayoutType BESTFIT
        Represents the picture-in-picture (pip) layout type.

      • VERTICAL

        public static final ScreenShareLayoutType VERTICAL
        Represents the vertical presentation layout type.

      • HORIZONTAL

        public static final ScreenShareLayoutType HORIZONTAL
        Represents the horizontal presentation layout type.

    • Method Detail

      • values

        public static ScreenShareLayoutType[] 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 (ScreenShareLayoutType c : ScreenShareLayoutType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ScreenShareLayoutType 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.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<ScreenShareLayoutType>