Package com.opentok

Enum RenderStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RenderStatus>
    public enum RenderStatus
extends java.lang.Enum<RenderStatus>
    Enum representing the status of a Render.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FAILED
      An error occurred and the Experience Composer could not proceed.
      STARTED
      The Vonage Video API platform has successfully connected to the remote application server, and is publishing the web view to an OpenTok stream.
      STARTING
      The Vonage Video API platform is in the process of connecting to the remote application at the URL provided.
      STOPPED
      The Experience Composer has stopped.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static RenderStatus fromString​(java.lang.String status)  
      java.lang.String toString()  
      static RenderStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RenderStatus[] 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

      • STARTING

        public static final RenderStatus STARTING
        The Vonage Video API platform is in the process of connecting to the remote application at the URL provided. This is the initial state.

      • STARTED

        public static final RenderStatus STARTED
        The Vonage Video API platform has successfully connected to the remote application server, and is publishing the web view to an OpenTok stream.

      • STOPPED

        public static final RenderStatus STOPPED
        The Experience Composer has stopped.

      • FAILED

        public static final RenderStatus FAILED
        An error occurred and the Experience Composer could not proceed. It may occur at startup if the OpenTok server cannot connect to the remote application server or republish the stream. It may also occur at any point during the process due to an error in the Vonage Video API platform.

    • Method Detail

      • values

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

      • valueOf

        public static RenderStatus 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

      • fromString

        public static RenderStatus fromString​(java.lang.String status)

      • toString

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