Developer_release_1.4.0
Class mint.bindings.status_wrapper
Status.
Methods
| mint.bindings.status_wrapper:contains_field (field) | Check if status field exists. |
| mint.bindings.status_wrapper:get_caps () | Retrieve device capabilities. |
| mint.bindings.status_wrapper:get_device_mode () | Retrieve device mode. |
| mint.bindings.status_wrapper:get_hdmi_data () | Retrieve HDMI data. |
| mint.bindings.status_wrapper:get_status () | Get status as JSON. |
| mint.bindings.status_wrapper:get_streaming_status () | Retrieve conncetion status for video and audio stream. |
| mint.bindings.status_wrapper:get_subframe_latency_enabled () | Check if subframe latency enabled. |
| mint.bindings.status_wrapper:get_uptime () | Retrieve uptime. |
| mint.bindings.status_wrapper:get_video_bit_rate_cap () | Returns video bitrate cap. |
| mint.bindings.status_wrapper:get_video_params () | Retrieve device video parameters. |
| mint.bindings.status_wrapper:is_ptp_enabled () | Check if ptp enabled. |
| mint.bindings.status_wrapper:stop_watch () | Stop watcher. |
| mint.bindings.status_wrapper:subscribe () | Subscribe on status changes events. |
Methods
- mint.bindings.status_wrapper:contains_field (field)
-
Check if status field exists.
Parameters:
- field (string)(const std::string &) field name
Returns:
-
(boolean)(bool) bool true if field exists (on success)
Or
-
nil - string Error message (on failure)
- mint.bindings.status_wrapper:get_caps ()
-
Retrieve device capabilities.
Returns:
-
(mint.structs.mint_capabilities) Copy of capabilities structure (on success)
Or
-
nil - string Error message (on failure)
-
- mint.bindings.status_wrapper:get_device_mode ()
-
Retrieve device mode.
Returns:
-
(mint.enums.device_mode) Copy of divece_mode structure (on success)
Or
-
nil - string Error message (on failure)
-
- mint.bindings.status_wrapper:get_hdmi_data ()
-
Retrieve HDMI data.
Returns:
-
(mint.structs.mint_hdmi_data) Copy of mint_hdmi_data structure (on success)
Or
-
nil - string Error message (on failure)
-
- mint.bindings.status_wrapper:get_status ()
-
Get status as JSON.
Returns:
-
(table) Status as JSON object (on success)
Or
-
nil - string Error message (on failure)
-
- mint.bindings.status_wrapper:get_streaming_status ()
-
Retrieve conncetion status for video and audio stream.
Returns:
-
(mint.structs.mint_streaming_status) Copy of mint_streams_connection_status structure (on success)
Or
-
nil - string Error message (on failure)
-
- mint.bindings.status_wrapper:get_subframe_latency_enabled ()
-
Check if subframe latency enabled.
Returns:
-
(boolean)(bool) true if subframe latency enabled (on success)
Or
-
nil - string Error message (on failure)
-
- mint.bindings.status_wrapper:get_uptime ()
-
Retrieve uptime.
Returns:
-
(integer)(int) Uptime (on success)
Or
-
nil - string Error message (on failure)
-
- mint.bindings.status_wrapper:get_video_bit_rate_cap ()
-
Returns video bitrate cap. Encoder only.
Returns:
-
(integer)(uint32_t) Video bitrate cap (on success)
Or
-
nil - string Error message (on failure)
-
- mint.bindings.status_wrapper:get_video_params ()
-
Retrieve device video parameters.
Returns:
-
(mint.structs.video_params) Copy of VideoParams structure (on success)
Or
-
nil - string Error message (on failure)
-
- mint.bindings.status_wrapper:is_ptp_enabled ()
-
Check if ptp enabled.
Returns:
-
(boolean)(bool) true if ptp enabled (on success)
Or
-
nil - string Error message (on failure)
-
- mint.bindings.status_wrapper:stop_watch ()
-
Stop watcher.
Returns:
true(on success)Or
-
nil - string Error message (on failure)
-
- mint.bindings.status_wrapper:subscribe ()
-
Subscribe on status changes events.
Usage:
status:subscribe('/media', function (key, event, value) print('media configuration changed: key: ' .. tostring(key)) print('media configuration changed: event: ' .. tostring(event)) print('media configuration changed: value: ' .. tpretty(value)) end)