QAndroidMediaFormat format;
format.setWidth(1920);
format.setHeight(1080);

QAndroidSurfaceStreamer streamer(format);
connect(&streamer, QOverload<QAndroidSurfaceStreamer::Error, const QString &>::of(&QAndroidSurfaceStreamer::error),
        this, &MyClass::onStreamingError);

if (!streamer.start(QHostAddress::LocalHost, 5554)) {
    qWarning() << "Failed to start streaming:" << streamer.errorString(streamer.lastError());
}

ANativeWindow *surface = streamer.surface();
// Use surface with Android graphics APIs...

streamer.stop(); // Stop streaming when done

Member Function Documentation

[explicit] QAndroidSurfaceStreamer::QAndroidSurfaceStreamer(QAndroidMediaFormat mediaFormat, QObject *parent = nullptr)

Constructs a QAndroidSurfaceStreamer object with the given mediaFormat and the specified parent.

The media format specifies the video resolution, frame rate, and other encoding parameters. Call start() to initialize the encoder and begin streaming.

See also mediaFormat() and start().

[override virtual noexcept] QAndroidSurfaceStreamer::~QAndroidSurfaceStreamer()

Destroys the QAndroidSurfaceStreamer object. If the streamer is currently running, stop() is called automatically to ensure all resources are properly released.

See also stop().

[signal] void QAndroidSurfaceStreamer::error(QAndroidSurfaceStreamer::Error error, const QString &details = QString())

This signal is emitted when an error occurs during streaming operations.

The error parameter contains the error code indicating the type of error that occurred. The details parameter provides additional information about the error and may include session identifiers or other debugging information.

Common errors include:

• Error::RtspPortFailed - The RTSP server port is not available
• Error::StreamPortFailed - UDP ports for RTP streaming could not be allocated
• Error::EncoderFailed - The H.264 encoder failed to initialize
• Error::InternalError - An internal error occurred

When an error signal is emitted, the streamer is automatically stopped and the running property is set to false.

See also lastError(), errorString(), and runningChanged().

[static] QString QAndroidSurfaceStreamer::errorString(QAndroidSurfaceStreamer::Error error)

Returns a human-readable error message for the given error error.

This static function provides descriptive text for each Error code, suitable for displaying to users or logging. The returned string is localization-ready.

See also Error, lastError(), and error().

bool QAndroidSurfaceStreamer::isRunning() const

Returns true if the streaming server is currently running; otherwise returns false.

See also start(), stop(), running, and runningChanged().

QAndroidSurfaceStreamer::Error QAndroidSurfaceStreamer::lastError() const

Returns the last error that occurred during streaming operations.

When an error occurs during streaming (e.g., encoder failure, port allocation failure), this method returns the error code. Detailed error information is also provided via the error() signal.

See also error() and errorString().

QAndroidMediaFormat QAndroidSurfaceStreamer::mediaFormat() const

Returns the media format that was specified when constructing the streamer.

The returned format contains the video resolution, frame rate, and other encoding parameters used by the H.264 encoder.

See also QAndroidMediaFormat.

[signal] void QAndroidSurfaceStreamer::runningChanged(bool running)

This signal is emitted when the streaming server is started or stopped.

The running parameter is true when the server has been successfully started, and false when the server has been stopped or failed to start.

See also start(), stop(), isRunning(), and running.

bool QAndroidSurfaceStreamer::start(const QHostAddress &host, quint16 port)

Starts the streaming server on the specified host address and port.

This method initializes the H.264 encoder, creates the RTP packet source, and starts the RTSP server. All streaming components run in a dedicated worker thread.

Returns true if the streaming was started successfully; otherwise returns false and sets lastError() to indicate the reason for failure.

After successful start, the running property is set to true and the runningChanged() signal is emitted. The surface() method can then be used to obtain the video surface.

If the streamer is already running, this method returns false and does nothing.

host may be QHostAddress::LocalHost to accept connections only from the local machine, or QHostAddress::Any to accept connections from any network interface.

port is the RTSP server port. The method will also attempt to allocate UDP ports starting from port + 1 for RTP data streams.

See also stop(), isRunning(), surface(), error(), and lastError().

void QAndroidSurfaceStreamer::stop()

Stops the streaming server and releases all associated resources.

This method performs a graceful shutdown of all streaming components:

• Stops the RTSP server
• Stops the RTP packet source and H.264 encoder
• Terminates the worker thread and waits for it to finish
• Releases all allocated resources (ports, memory, etc.)

If the streamer is not running, this method does nothing.

After successful stop, the running property is set to false and the runningChanged() signal is emitted.

The method waits up to 5 seconds for the worker thread to finish. If the thread does not terminate within this timeout, it is left to finish naturally to avoid potential crashes.

See also start(), isRunning(), and running.

ANativeWindow *QAndroidSurfaceStreamer::surface() const

Returns a pointer to the native Android surface (ANativeWindow) used for video encoding.

The surface is created and managed by the H.264 RTP packet source. Video frames should be rendered to this surface using Android graphics APIs such as OpenGL ES or Vulkan.

Returns nullptr if the streamer is not running or if the encoder has not yet been initialized.

See also start() and isRunning().