package Torello.Browser.BrowserAPI;

// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// Java-HTML Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import Torello.Browser.*;
import Torello.Browser.helper.*;
import Torello.Browser.JavaScriptAPI.*;
import Torello.JSON.*;

import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.Java.ReadOnly.ReadOnlyArrayList;

import Torello.JavaDoc.Annotations.StaticFunctional;
import Torello.JavaDoc.Annotations.JDHeaderBackgroundImg;


// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// JDK Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import javax.json.JsonObject;
import javax.json.JsonValue;

/**
 * <SPAN CLASS=COPIEDJDK><B>This domain allows detailed inspection of media elements</B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class Media
{
    // No Pubic Constructors
    private Media() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Eliminated Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Players will get an ID that is unique within the agent context.

     * <EMBED CLASS='external-html' DATA-CTAS='String' DATA-FILE-ID=CDP.EliminatedType
     *     DATA-NAME=PlayerId>
     */
    public static final String PlayerId =
        "PlayerId has been eliminated.\n" +
        "It was replaced with the standard Java-Type: String";

    /**
     * <CODE>[No Description Provided by Google]</CODE>

     * <EMBED CLASS='external-html' DATA-CTAS='Number' DATA-FILE-ID=CDP.EliminatedType
     *     DATA-NAME=Timestamp>
     */
    public static final String Timestamp =
        "Timestamp has been eliminated.\n" +
        "It was replaced with the standard Java-Type: Number";



    // ********************************************************************************************
    // ********************************************************************************************
    // Basic Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Corresponds to kMediaError
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Media DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class PlayerError
        extends BaseType<PlayerError>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Media.PlayerError> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                Media$$PlayerError$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String errorType;

        /**
         * Code is the numeric enum entry for a specific set of error codes, such
         * as PipelineStatusCodes in media/base/pipeline_status.h
         */
        public final int code;

        /** A trace of where this error was caused / where it passed through. */
        public final Media.PlayerErrorSourceLocation[] stack;

        /**
         * Errors potentially have a root cause error, ie, a DecoderError might be
         * caused by an WindowsError
         */
        public final Media.PlayerError[] cause;

        /** Extra data attached to an error, such as an HRESULT, Video Codec, etc. */
        public final JsonValue data;

        /** Constructor.  Please review this class' fields for documentation. */
        public PlayerError(
                ReadOnlyList<Boolean> isPresent, String errorType, int code,
                PlayerErrorSourceLocation[] stack, PlayerError[] cause, JsonValue data
            )
        {
            super(singleton, Domains.Media, "PlayerError", 5);

            this.errorType  = errorType;
            this.code       = code;
            this.stack      = stack;
            this.cause      = cause;
            this.data       = data;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 5, "Media.PlayerError");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static PlayerError fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<PlayerError> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Represents logged source line numbers reported in an error.
     * NOTE: file and line are from chromium c++ implementation code, not js.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Media DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class PlayerErrorSourceLocation
        extends BaseType<PlayerErrorSourceLocation>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Media.PlayerErrorSourceLocation> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                Media$$PlayerErrorSourceLocation$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String file;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final int line;

        /** Constructor.  Please review this class' fields for documentation. */
        public PlayerErrorSourceLocation(ReadOnlyList<Boolean> isPresent, String file, int line)
        {
            super(singleton, Domains.Media, "PlayerErrorSourceLocation", 2);

            this.file = file;
            this.line = line;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Media.PlayerErrorSourceLocation");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static PlayerErrorSourceLocation fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<PlayerErrorSourceLocation> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Corresponds to kMediaEventTriggered
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Media DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class PlayerEvent
        extends BaseType<PlayerEvent>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Media.PlayerEvent> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                Media$$PlayerEvent$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Number timestamp;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String value;

        /** Constructor.  Please review this class' fields for documentation. */
        public PlayerEvent(ReadOnlyList<Boolean> isPresent, Number timestamp, String value)
        {
            super(singleton, Domains.Media, "PlayerEvent", 2);

            this.timestamp  = timestamp;
            this.value      = value;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Media.PlayerEvent");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static PlayerEvent fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<PlayerEvent> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Have one type per entry in MediaLogRecord::Type
     * Corresponds to kMessage
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Media DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class PlayerMessage
        extends BaseType<PlayerMessage>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Media.PlayerMessage> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                Media$$PlayerMessage$$.singleton;

        /**
         * Keep in sync with MediaLogMessageLevel
         * We are currently keeping the message level 'error' separate from the
         * PlayerError type because right now they represent different things,
         * this one being a DVLOG(ERROR) style log message that gets printed
         * based on what log level is selected in the UI, and the other is a
         * representation of a media::PipelineStatus object. Soon however we're
         * going to be moving away from using PipelineStatus for errors and
         * introducing a new error type which should hopefully let us integrate
         * the error log level into the PlayerError type.
         * <EMBED CLASS='external-html' DATA-D=Media DATA-C=PlayerMessage DATA-F=level DATA-FILE-ID=CDP.EL1>
         * @see BaseType#enumStrList(String)
         */
        public final String level;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String message;

        /** Constructor.  Please review this class' fields for documentation. */
        public PlayerMessage(ReadOnlyList<Boolean> isPresent, String level, String message)
        {
            super(singleton, Domains.Media, "PlayerMessage", 2);

            this.level      = level;
            this.message    = message;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Media.PlayerMessage");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static PlayerMessage fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<PlayerMessage> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Corresponds to kMediaPropertyChange
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Media DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class PlayerProperty
        extends BaseType<PlayerProperty>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Media.PlayerProperty> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                Media$$PlayerProperty$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String name;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String value;

        /** Constructor.  Please review this class' fields for documentation. */
        public PlayerProperty(ReadOnlyList<Boolean> isPresent, String name, String value)
        {
            super(singleton, Domains.Media, "PlayerProperty", 2);

            this.name   = name;
            this.value  = value;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Media.PlayerProperty");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static PlayerProperty fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<PlayerProperty> descriptor()
        { return singleton.descriptor(); }
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Event Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Send a list of any errors that need to be delivered.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Media DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class playerErrorsRaised
        extends BrowserEvent<playerErrorsRaised>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Media.playerErrorsRaised> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Events.
                Media$$playerErrorsRaised$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String playerId;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Media.PlayerError[] errors;

        /** Constructor.  Please review this class' fields for documentation. */
        public playerErrorsRaised
            (ReadOnlyList<Boolean> isPresent, String playerId, PlayerError[] errors)
        {
            super(singleton, Domains.Media, "playerErrorsRaised", 2);

            this.playerId   = playerId;
            this.errors     = errors;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Media.playerErrorsRaised");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static playerErrorsRaised fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<playerErrorsRaised> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Send events as a list, allowing them to be batched on the browser for less
     * congestion. If batched, events must ALWAYS be in chronological order.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Media DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class playerEventsAdded
        extends BrowserEvent<playerEventsAdded>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Media.playerEventsAdded> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Events.
                Media$$playerEventsAdded$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String playerId;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Media.PlayerEvent[] events;

        /** Constructor.  Please review this class' fields for documentation. */
        public playerEventsAdded
            (ReadOnlyList<Boolean> isPresent, String playerId, PlayerEvent[] events)
        {
            super(singleton, Domains.Media, "playerEventsAdded", 2);

            this.playerId   = playerId;
            this.events     = events;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Media.playerEventsAdded");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static playerEventsAdded fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<playerEventsAdded> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Send a list of any messages that need to be delivered.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Media DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class playerMessagesLogged
        extends BrowserEvent<playerMessagesLogged>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Media.playerMessagesLogged> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Events.
                Media$$playerMessagesLogged$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String playerId;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Media.PlayerMessage[] messages;

        /** Constructor.  Please review this class' fields for documentation. */
        public playerMessagesLogged
            (ReadOnlyList<Boolean> isPresent, String playerId, PlayerMessage[] messages)
        {
            super(singleton, Domains.Media, "playerMessagesLogged", 2);

            this.playerId = playerId;
            this.messages = messages;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Media.playerMessagesLogged");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static playerMessagesLogged fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<playerMessagesLogged> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * This can be called multiple times, and can be used to set / override /
     * remove player properties. A null propValue indicates removal.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Media DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class playerPropertiesChanged
        extends BrowserEvent<playerPropertiesChanged>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Media.playerPropertiesChanged> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Events.
                Media$$playerPropertiesChanged$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String playerId;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Media.PlayerProperty[] properties;

        /** Constructor.  Please review this class' fields for documentation. */
        public playerPropertiesChanged
            (ReadOnlyList<Boolean> isPresent, String playerId, PlayerProperty[] properties)
        {
            super(singleton, Domains.Media, "playerPropertiesChanged", 2);

            this.playerId   = playerId;
            this.properties = properties;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Media.playerPropertiesChanged");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static playerPropertiesChanged fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<playerPropertiesChanged> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Called whenever a player is created, or when a new agent joins and receives
     * a list of active players. If an agent is restored, it will receive the full
     * list of player ids and all events again.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Media DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class playersCreated
        extends BrowserEvent<playersCreated>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Media.playersCreated> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Events.
                Media$$playersCreated$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String[] players;

        /** Constructor.  Please review this class' fields for documentation. */
        public playersCreated(ReadOnlyList<Boolean> isPresent, String[] players)
        {
            super(singleton, Domains.Media, "playersCreated", 1);

            this.players = players;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 1, "Media.playersCreated");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static playersCreated fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<playersCreated> descriptor()
        { return singleton.descriptor(); }
    }




    // ********************************************************************************************
    // ********************************************************************************************
    // Commands
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Disables the Media domain.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> disable()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Media.disable\"}";

        return Script.NO_RET(Domains.Media, "disable", requestJSON);
    }

    /**
     * Enables the Media domain
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> enable()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Media.enable\"}";

        return Script.NO_RET(Domains.Media, "enable", requestJSON);
    }


}