# lv_gstreamer.h (/api/public/widgets/lv_gstreamer_h) Functions [#functions] lv_gstreamer_set_src [#lv_gstreamer_set_src] Add a source to this gstreamer object ```c title=" " lineNumbers=1 lv_result_t lv_gstreamer_set_src(lv_obj_t *obj, const char *factory_name, const char *property, const char *source) ``` Parameters | Name | Type | Description | | -------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `obj` | | pointer to a gstreamer object | | `factory_name` | `const char *` | the factory name for the source of this gstreamer object. for common factory names, check `LV_GSTREAMER_FACTORY_XXX` defines | | `property` | `const char *` | the property name for the gstreamer source object for common properties, see `LV_GSTREAMER_PROPERTY_XXX` defines **May** be `NULL`. When NULL the source object is created but its source is not set. | | `source` | `const char *` | the property value for the gstreamer source object **May** be `NULL`. When NULL the source object is created but its source is not set. | **Returns:** — LV\_RESULT\_OK if the source was correctly set else LV\_RESULT\_INVALID lv_gstreamer_set_position [#lv_gstreamer_set_position] Seek a position in this gstreamer ```c title=" " lineNumbers=1 void lv_gstreamer_set_position(lv_obj_t *obj, uint32_t position) ``` Parameters | Name | Type | Description | | ---------- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a gstreamer object | | `position` | `uint32_t` | position to seek to | lv_gstreamer_set_volume [#lv_gstreamer_set_volume] Set the volume of this gstreamer ```c title=" " lineNumbers=1 void lv_gstreamer_set_volume(lv_obj_t *obj, uint8_t volume) ``` Parameters | Name | Type | Description | | -------- | ------------------------------------------------ | ------------------------------------------------------------------ | | `obj` | | pointer to a gstreamer object | | `volume` | `uint8_t` | the value to set in the range \[0..100]. Higher values are clamped | lv_gstreamer_set_rate [#lv_gstreamer_set_rate] Set the speed rate of this gstreamer ```c title=" " lineNumbers=1 void lv_gstreamer_set_rate(lv_obj_t *obj, uint32_t rate) ``` Parameters | Name | Type | Description | | ------ | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | | `obj` | | pointer to a gstreamer object | | `rate` | `uint32_t` | the rate factor. Example values:
- 256: 1x
- \<256: slow down
- >256: speed up
- 128: 0.5x
- 512: 2x | lv_gstreamer_get_duration [#lv_gstreamer_get_duration] Get the duration of this gstreamer ```c title=" " lineNumbers=1 uint32_t lv_gstreamer_get_duration(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a gstreamer object | **Returns:** `uint32_t` — the duration (in ms) of the gstreamer object lv_gstreamer_get_position [#lv_gstreamer_get_position] Get the position of this gstreamer ```c title=" " lineNumbers=1 uint32_t lv_gstreamer_get_position(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a gstreamer object | **Returns:** `uint32_t` — the position (in ms) of the gstreamer object lv_gstreamer_get_state [#lv_gstreamer_get_state] Get the state of this gstreamer ```c title=" " lineNumbers=1 lv_gstreamer_state_t lv_gstreamer_get_state(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a gstreamer object | lv_gstreamer_get_volume [#lv_gstreamer_get_volume] Get the volume of this gstreamer ```c title=" " lineNumbers=1 uint8_t lv_gstreamer_get_volume(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a gstreamer object | **Returns:** `uint8_t` — the volume for this gstreamer lv_gstreamer_get_stream_state [#lv_gstreamer_get_stream_state] Retrieve the stream state from a STATE\_CHANGED event callback ```c title=" " lineNumbers=1 lv_gstreamer_stream_state_t lv_gstreamer_get_stream_state(lv_event_t *e) ``` Parameters | Name | Type | Description | | ---- | ---------------------------------------------------- | -------------------- | | `e` | | pointer to the event | **Returns:** — the stream state or `LV_GSTREAMER_STREAM_STATE_INVALID` if `e` is invalid lv_gstreamer_create [#lv_gstreamer_create] Create a gstreamer object ```c title=" " lineNumbers=1 lv_obj_t * lv_gstreamer_create(lv_obj_t *parent) ``` Parameters | Name | Type | Description | | -------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | | `parent` | | pointer to a parent widget **May** be `NULL`.. When NULL, the widget is created as a screen on the default display. | **Returns:** — pointer to the created gstreamer lv_gstreamer_play [#lv_gstreamer_play] Play this gstreamer ```c title=" " lineNumbers=1 void lv_gstreamer_play(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a gstreamer object | lv_gstreamer_pause [#lv_gstreamer_pause] Pause this gstreamer ```c title=" " lineNumbers=1 void lv_gstreamer_pause(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a gstreamer object | lv_gstreamer_stop [#lv_gstreamer_stop] Stop this gstreamer ```c title=" " lineNumbers=1 void lv_gstreamer_stop(lv_obj_t *obj) ``` Parameters | Name | Type | Description | | ----- | ------------------------------------------------ | ----------------------------- | | `obj` | | pointer to a gstreamer object | Enums [#enums] lv_gstreamer_state_t [#lv_gstreamer_state_t] | Name | | ---------------------------- | | `LV_GSTREAMER_STATE_NULL` | | `LV_GSTREAMER_STATE_READY` | | `LV_GSTREAMER_STATE_PAUSED` | | `LV_GSTREAMER_STATE_PLAYING` | lv_gstreamer_stream_state_t [#lv_gstreamer_stream_state_t] | Name | Value | | ----------------------------------- | ----- | | `LV_GSTREAMER_STREAM_STATE_INVALID` | `-1` | | `LV_GSTREAMER_STREAM_STATE_START` | | | `LV_GSTREAMER_STREAM_STATE_PLAY` | | | `LV_GSTREAMER_STREAM_STATE_PAUSE` | | | `LV_GSTREAMER_STREAM_STATE_STOP` | | | `LV_GSTREAMER_STREAM_STATE_END` | | Macros [#macros] LV_GSTREAMER_FACTORY_URI_DECODE [#lv_gstreamer_factory_uri_decode] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_FACTORY_URI_DECODE "uridecodebin" ``` LV_GSTREAMER_PROPERTY_URI_DECODE [#lv_gstreamer_property_uri_decode] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_PROPERTY_URI_DECODE "uri" ``` LV_GSTREAMER_FACTORY_FILE [#lv_gstreamer_factory_file] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_FACTORY_FILE "filesrc" ``` LV_GSTREAMER_PROPERTY_FILE [#lv_gstreamer_property_file] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_PROPERTY_FILE "location" ``` LV_GSTREAMER_FACTORY_HTTP [#lv_gstreamer_factory_http] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_FACTORY_HTTP "souphttpsrc" ``` LV_GSTREAMER_PROPERTY_HTTP [#lv_gstreamer_property_http] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_PROPERTY_HTTP "location" ``` LV_GSTREAMER_FACTORY_HTTPS [#lv_gstreamer_factory_https] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_FACTORY_HTTPS "souphttpsrc" ``` LV_GSTREAMER_PROPERTY_HTTPS [#lv_gstreamer_property_https] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_PROPERTY_HTTPS "location" ``` LV_GSTREAMER_FACTORY_V4L2_CAMERA [#lv_gstreamer_factory_v4l2_camera] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_FACTORY_V4L2_CAMERA "v4l2src" ``` LV_GSTREAMER_PROPERTY_V4L2_CAMERA [#lv_gstreamer_property_v4l2_camera] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_PROPERTY_V4L2_CAMERA "device" ``` LV_GSTREAMER_FACTORY_ALSA_AUDIO [#lv_gstreamer_factory_alsa_audio] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_FACTORY_ALSA_AUDIO "alsasrc" ``` LV_GSTREAMER_PROPERTY_ALSA_AUDIO [#lv_gstreamer_property_alsa_audio] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_PROPERTY_ALSA_AUDIO "device" ``` LV_GSTREAMER_FACTORY_PULSE_AUDIO [#lv_gstreamer_factory_pulse_audio] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_FACTORY_PULSE_AUDIO "pulsesrc" ``` LV_GSTREAMER_PROPERTY_PULSE_AUDIO [#lv_gstreamer_property_pulse_audio] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_PROPERTY_PULSE_AUDIO "device" ``` LV_GSTREAMER_FACTORY_TEST_AUDIO [#lv_gstreamer_factory_test_audio] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_FACTORY_TEST_AUDIO "audiotestsrc" ``` LV_GSTREAMER_PROPERTY_TEST_AUDIO [#lv_gstreamer_property_test_audio] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_PROPERTY_TEST_AUDIO NULL ``` LV_GSTREAMER_FACTORY_TEST_VIDEO [#lv_gstreamer_factory_test_video] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_FACTORY_TEST_VIDEO "videotestsrc" ``` LV_GSTREAMER_PROPERTY_TEST_VIDEO [#lv_gstreamer_property_test_video] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_PROPERTY_TEST_VIDEO NULL ``` LV_GSTREAMER_FACTORY_APP [#lv_gstreamer_factory_app] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_FACTORY_APP "appsrc" ``` LV_GSTREAMER_PROPERTY_APP [#lv_gstreamer_property_app] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_PROPERTY_APP NULL ``` LV_GSTREAMER_FACTORY_WEBRTCSRC [#lv_gstreamer_factory_webrtcsrc] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_FACTORY_WEBRTCSRC "webrtcsrc" ``` LV_GSTREAMER_PROPERTY_WEBRTCSRC [#lv_gstreamer_property_webrtcsrc] ```c title=" " lineNumbers=1 #define LV_GSTREAMER_PROPERTY_WEBRTCSRC "signaller::uri" ``` Dependencies [#dependencies]