src/references/instructions/server/stream/video.xml

<?xml version="1.0" encoding="UTF-8"?>

<section xml:id="video-stream-instruction" xmlns="http://docbook.org/ns/docbook"
    version="5.0" xml:lang="en" xmlns:xi="http://www.w3.org/2001/XInclude">
    <title>video</title>
    <indexterm>
        <primary>video</primary>
    </indexterm>
    <para>Allocates a new stream, associating it with the given video metadata. Video data will
        later be sent along the stream with blob instructions. The mimetype given must be a mimetype
        previously specified by the client during the handshake procedure. Playback will begin
        immediately and will continue as long as blobs are received along the stream.</para>
    <variablelist>
        <varlistentry>
            <term><parameter>stream</parameter></term>
            <listitem>
                <para>The index of the stream to allocate.</para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>layer</parameter></term>
            <listitem>
                <para>The index of the layer to stream the video data into. The effect of other
                    drawing operations on this layer during playback is undefined, as the client
                    codec implementation may leverage any rendering mechanism it sees fit, including
                    hardware decoding.</para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>mimetype</parameter></term>
            <listitem>
                <para>The mimetype of the video data being sent.</para>
            </listitem>
        </varlistentry>
    </variablelist>
</section>