GstBusWatch.h File

Helpers for watching a GStreamer pipeline's message bus. More...

Included Headers

#include <string>

Namespaces Index

namespace	simaai
namespace	neat

Typedefs Index

typedef	struct _GstElement GstElement
	Forward declaration of GStreamer's GstElement struct. More...
typedef	struct _GstMessage GstMessage
	Forward declaration of GStreamer's GstMessage struct. More...

Description

Helpers for watching a GStreamer pipeline's message bus.

Provides a small set of free functions used by Run/Session to drain bus messages and surface them into the framework's reporting layer (SessionReport entries, SessionError exceptions). Forward-declares the GStreamer C types so this header doesn't drag the full <gst/gst.h> into framework public headers.

See Also

SessionReport

See Also

SessionError

Typedefs

GstElement

typedef struct _GstElement GstElement

Forward declaration of GStreamer's GstElement struct.

Definition at line 21 of file GstBusWatch.h.

21typedef struct _GstElement GstElement;

GstMessage

typedef struct _GstMessage GstMessage

Forward declaration of GStreamer's GstMessage struct.

Definition at line 23 of file GstBusWatch.h.

23typedef struct _GstMessage GstMessage;

File Listing

The file content with the documentation metadata removed is:

1

14#pragma once

15

16#include <string>

17

18struct _GstElement;

19struct _GstMessage;

21typedef struct _GstElement GstElement;

23typedef struct _GstMessage GstMessage;

24

25namespace simaai::neat {

26

32using BusMessageFn = void (*)(const char* type, const char* src, const std::string& line,

33 void* user_data);

34

36using BusErrorFn = void (*)(const std::string& line, void* user_data);

37

43std::string gst_message_to_string(GstMessage* msg);

44

55void drain_bus(GstElement* pipeline, BusMessageFn on_message, void* user_data);

56

69void throw_if_bus_error(GstElement* pipeline, BusMessageFn on_message, void* user_data,

70 BusErrorFn on_error, void* error_user_data);

71

72} // namespace simaai::neat

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.