Class VideoWriter

CodenameOne/src/com/codename1/media/VideoWriter.java:53–154

/// w.close();
/// ```
public abstract class VideoWriter {
    /// Writes a single video frame at the given presentation timestamp. The frame may be
    /// any `Image`; its pixels are read via `Image#getRGB()`. Frames should be supplied
    /// in non decreasing timestamp order.
    ///
    /// #### Parameters
    ///
    /// - `frame`: the frame to encode, expected to match the configured width and height
    ///
    /// - `presentationTimeMillis`: the timestamp of this frame in milliseconds
    ///
    /// #### Throws
    ///
    /// - `IOException`: if encoding fails
    public void writeFrame(Image frame, long presentationTimeMillis) throws IOException {
        writeFrame(frame.getRGB(), frame.getWidth(), frame.getHeight(), presentationTimeMillis);
    }

    /// Writes a single video frame supplied as a raw ARGB pixel array. This is the method
    /// platform implementations provide; `#writeFrame(Image, long)` funnels into it.
    ///
    /// #### Parameters
    ///
    /// - `argb`: the frame pixels in ARGB order, length `width * height`
    ///
    /// - `width`: the frame width in pixels
    ///
    /// - `height`: the frame height in pixels
    ///
    /// - `presentationTimeMillis`: the timestamp of this frame in milliseconds
    ///
    /// #### Throws
    ///
    /// - `IOException`: if encoding fails
    public abstract void writeFrame(int[] argb, int width, int height, long presentationTimeMillis) throws IOException;

    /// Writes a block of interleaved PCM audio samples at the given timestamp. Samples
    /// are signed 16 bit, interleaved by channel. The audio track must have been enabled
    /// with `VideoWriterBuilder#hasAudio(boolean)`.
    ///
    /// #### Parameters
    ///
    /// - `interleavedPcm`: signed 16 bit interleaved samples
    ///
    /// - `sampleRate`: the sample rate of the supplied data in Hz
    ///
    /// - `channels`: the number of interleaved channels
    ///
    /// - `presentationTimeMillis`: the timestamp of the first sample in milliseconds
    ///
    /// #### Throws
    ///
    /// - `IOException`: if encoding fails
    public abstract void writeAudio(short[] interleavedPcm, int sampleRate, int channels, long presentationTimeMillis) throws IOException;

    /// Convenience method that writes the current contents of an `AudioBuffer` (which
    /// stores floating point samples) as 16 bit PCM. The buffer's own sample rate and
    /// channel count are used.