Developer_release_1.4.0

Class mint.bindings.daemon_connector_wrapper

Main class for work with the MINT daemon.

Common rules

All IPv4 addresses and their derivatives should be used in a form of human-readable string with IPv4 address (example: '192.168.1.1').

MAC addresses should be used in a form of human-readable string with MAC address (example: '18:A6:F7:BC:85:FC').

Usage:

  • local mint = require 'mint'
local dc = mint:daemon_connector()
dc:start_video_unicast(ip, 80, 80)
dc:start_audio_unicast(ip, 81, 81)

  • dc:start_video_unicast(ip, 80, 80)
dc:start_audio_unicast(ip, 81, 81)

Methods

dc:apply_net_params () Apply IP and MAC to media interface.
dc:can_kvm_connect () Check if KVM can connect.
dc:can_start_stream () Check if stream can start.
dc:cli_keyb_event (event) KVM client send keyboard event.
dc:cli_mouse_event (event) KVM client send mouse event.
dc:cli_set_ip (ip) KVM set client ip.
dc:cli_set_port (port) KVM set client port.
dc:cli_set_start () KVM client set start command.
dc:cli_set_stop () KVM client set stop command.
dc:configure_ip (ip, netmask, gateway) Configure device network settings.
dc:configure_mac (mac) Configure device MAC address.
dc:device_init () Init device.
dc:dispose () Closes the connection.
dc:get_active_partition () Returns active partition.
dc:get_audio_format () Retrieve device audio format.
dc:get_audio_infoframe () Returns audio infoframe.
dc:get_avi_infoframe () Returns AVI infoframe.
dc:get_bandwidth_limits () Returns bandwidth limits.
dc:get_caps () Retrieve device capabilities.
dc:get_compression_rate () Returns compression rate.
dc:get_cpu_usage_graph () Returns current board's CPU usage in a form of the CPU usage time points table.
dc:get_current_cpu_usage () Returns current board's CPU usage in percents.
dc:get_current_temperature () Get board's current temperature in Celsius and Fahrenheit.
dc:get_current_temperature_raw () Returns current temperature of the Board in Celsius.
dc:get_device_mode () Retrieve device mode.
dc:get_device_name () Retrieve device name.
dc:get_edid ([debug=false]) Returns EDID data.
dc:get_edid_file () Returns a path to the EDID file.
dc:get_fpga_version () Retrieve FPGA version.
dc:get_hdmi_data () Returns HDMI data.
dc:get_hostname () Retrieve hostname.
dc:get_linux_version () Returns Linux version.
dc:get_ll_api_version () Retrieve LL-API version.
dc:get_mac_address () Retrieve mac address.
dc:get_mint_version () Retrieve MINT API version.
dc:get_module_rev () Returns module revision.
dc:get_raw_edid () Returns raw EDID data.
dc:get_serial_number () Returns module revision.
dc:get_streaming_status () Retrieve connection status for video and audio streams.
dc:get_subframe_latency_enabled () Check if subframe latency enabled.
dc:get_temperature_graph () Returns measured temperatures table in a form of temperature time points.
dc:get_transport_type () Retrieve device transport type.
dc:get_uptime () Returns current board uptime.
dc:get_video_bit_rate_cap () Returns video bitrate cap.
dc:get_video_format () Retrieve device video format.
dc:get_video_params () Returns device video parameters.
dc:is_ptp_enabled () Check if ptp enabled.
dc:reboot_device ([delay=5]) Reboot device.
dc:run_async_if_event (event_type, data) Running async method of AsyncIfEventType.
dc:set_compression_rate (compression_rate) Set compression rate.
dc:set_default_essentials () Set default essential EDID.
dc:set_drop_packets (drop_packets_number) Set drop packets number.
dc:set_dynamic_debug (flag) Sets dynamic debug.
dc:set_edid_binary (file_path) Sets the EDID of the Encoder.
dc:set_encoder_ip (ip) Set encoder IP
dc:set_essentials (essentials) Set essential EDID.
dc:set_hostname (hostname) Set device hostname.
dc:set_media_interface (up) Set media interface up or down.
dc:set_rx_video_mode_essentials (essentials) Set RX video mode essentials.
dc:set_video_bit_rate_cap (video_bit_rate_cap) Set video bitrate cap.
dc:srv_set_port (port) KVM server set port.
dc:srv_set_start () KVM server set start command.
dc:srv_set_stop () KVM server set stop command.
dc:start_audio_multicast (multicast_remote_ip, multicast_remote_port, local_port, audio_params) Start the multicast audio stream.
dc:start_audio_unicast (remote_ip, remote_port, local_port, audio_params) Start the unicast audio stream.
dc:start_video_multicast (multicast_remote_ip, multicast_remote_port, local_port[, video_mode=mint.VIDEO_NOT_SET]) Start the multicast video stream.
dc:start_video_unicast (remote_ip, remote_port, local_port[, video_mode=mint.VIDEO_NOT_SET]) Start the unicast video stream.
dc:stop_audio () Stop the audio stream.
dc:stop_stream (kind) Stop transmitting stream.
dc:stop_video () Stop the video stream.


Methods

dc:apply_net_params ()
Apply IP and MAC to media interface.

Returns:

    bool true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:can_kvm_connect ()
Check if KVM can connect.

Returns:

    (boolean)(bool) true if KVM can connect (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:can_start_stream ()
Check if stream can start.

Returns:

    (boolean)(bool) true if stream can start (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:cli_keyb_event (event)
KVM client send keyboard event.

Parameters:

  • event (string)(const std::string &) Keyboard event from client

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:cli_mouse_event (event)
KVM client send mouse event.

Parameters:

  • event (string)(const std::string &) Mouse event from client

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:cli_set_ip (ip)
KVM set client ip.

Parameters:

  • ip (integer)(const uint32_t &) KVM client ipv4 address

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:cli_set_port (port)
KVM set client port.

Parameters:

  • port (integer)(const uint32_t &) KVM client port

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:cli_set_start ()
KVM client set start command.

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:cli_set_stop ()
KVM client set stop command.

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:configure_ip (ip, netmask, gateway)
Configure device network settings.

Parameters:

Returns:

    none

Usage:

    dc:configure_ip('192.168.1.2', '255.255.255.0', '192.168.1.1')
dc:configure_mac (mac)
Configure device MAC address.

Parameters:

Returns:

    none

Usage:

    dc:configure_mac('18:A6:F7:BC:85:FC')
dc:device_init ()
Init device.

Returns:

    bool true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:dispose ()
Closes the connection. Optional. Will be automatically invoked by the garbage collector when no references to dc are left.

Returns:

    none

Usage:

    dc:dispose()
dc:get_active_partition ()
Returns active partition.

Returns:

    string Active partition (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_audio_format ()
Retrieve device audio format.

Returns:

  1. nil
  2. string Error message (on failure)
dc:get_audio_infoframe ()
Returns audio infoframe. Encoder only.

Returns:

    (mint.structs.xhdmic.audio_info_frame) Audio infoframe table (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_avi_infoframe ()
Returns AVI infoframe. Encoder only.

Returns:

    (mint.structs.xhdmic.avi_info_frame) AVI infoframe table (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_bandwidth_limits ()
Returns bandwidth limits.

Returns:

    (number[])(std::vector) Bandwidth_limits (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_caps ()
Retrieve device capabilities. device capabilities.

Returns:

    (mint_capabilities) Current
dc:get_compression_rate ()
Returns compression rate. Encoder only.

Returns:

    (number)(double) Compression rate (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_cpu_usage_graph ()
Returns current board's CPU usage in a form of the CPU usage time points table.

Returns:

    (mint.structs.mint_cpu_usage_point[]) Array of CPU usage time points.

Or

  1. nil
  2. string Error message (on failure)
dc:get_current_cpu_usage ()
Returns current board's CPU usage in percents.

Returns:

    (mint.structs.mint_cpu_usage_point) CPU usage in percents and timestamp.

Or

  1. nil
  2. string Error message (on failure)
dc:get_current_temperature ()
Get board's current temperature in Celsius and Fahrenheit.

Returns:

    (mint.structs.mint_temperature_data) Temperature data

Or

  1. nil
  2. string Error message (on failure)
dc:get_current_temperature_raw ()
Returns current temperature of the Board in Celsius.

Returns:

    (mint.structs.mint_temperature_point) Temperature point

Or

  1. nil
  2. string Error message (on failure)
dc:get_device_mode ()
Retrieve device mode.

Returns:

    (mint.enums.device_mode) Device mode

See also:

Usage:

  • print(dc:get_device_mode())
  • dc:get_device_mode()
dc:get_device_name ()
Retrieve device name.

Returns:

    string Device name

Usage:

  • print(dc:get_device_name())
  • dc:get_device_name()
dc:get_edid ([debug=false])
Returns EDID data.

Parameters:

  • debug boolean Return empty EDID struct on error (default false)

Returns:

    (mint.structs.mint_edid_data_type) EDID data (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_edid_file ()
Returns a path to the EDID file.

Returns:

    string EDID file path (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_fpga_version ()
Retrieve FPGA version.

Returns:

    string Currently used FPGA version

Usage:

    print('Current version of the FPGA:', dc:get_fpga_version())
dc:get_hdmi_data ()
Returns HDMI data.

Returns:

    (mint.structs.mint_hdmi_data) HDMI data (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_hostname ()
Retrieve hostname.

Returns:

    (string)(std::string) Hostname as string (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_linux_version ()
Returns Linux version.

Returns:

    string Linux version (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_ll_api_version ()
Retrieve LL-API version.

Returns:

    string Currently used LL-API version

Usage:

    print('Current version of the LL-API:', dc:get_ll_api_version())
dc:get_mac_address ()
Retrieve mac address.

Returns:

    (string)(mint::mac_t) Mac address (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_mint_version ()
Retrieve MINT API version.

Returns:

    string Currently used MINT API version

Usage:

    print('Current version of the MINT API:', dc:get_mint_version())
dc:get_module_rev ()
Returns module revision.

Returns:

    string Module revision (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_raw_edid ()
Returns raw EDID data.

Returns:

    string Raw EDID data (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_serial_number ()
Returns module revision.

Returns:

    string Serial number (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_streaming_status ()
Retrieve connection status for video and audio streams.

Returns:

    (@{mint_streaming_status}) Streaming status (on success)

Or

  1. nil
  2. string Error message (on failure)

Usage:

    for k, v in pairs(dc:get_streaming_status()) do
  print(k, v)
end
dc:get_subframe_latency_enabled ()
Check if subframe latency enabled.

Returns:

    (boolean)(bool) true if subframe latency enabled (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_temperature_graph ()
Returns measured temperatures table in a form of temperature time points.

Returns:

    (mint.structs.mint_temperature_point[]) Array of temperature points.

Or

  1. nil
  2. string Error message (on failure)
dc:get_transport_type ()
Retrieve device transport type.

Returns:

    (mint.enums.transport_type) Transport type

See also:

Usage:

  • local transport_type = dc:get_transport_type()
  • dc:get_transport_type()
dc:get_uptime ()
Returns current board uptime.

Returns:

    number Uptime (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_video_bit_rate_cap ()
Returns video bitrate cap. Encoder only.

Returns:

    (integer)(uint32_t) Video bitrate cap (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:get_video_format ()
Retrieve device video format.

Returns:

  1. nil
  2. string Error message (on failure)
dc:get_video_params ()
Returns device video parameters.

Returns:

    (mint.structs.video_params) Copy of VideoParams structure (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:is_ptp_enabled ()
Check if ptp enabled.

Returns:

    (boolean)(bool) true if ptp enabled (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:reboot_device ([delay=5])
Reboot device.

Parameters:

  • delay number Delay before reboot, in seconds (default 5)

Returns:

    bool true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:run_async_if_event (event_type, data)
Running async method of AsyncIfEventType.

Parameters:

  • event_type (integer)(const uint32_t &) event type id
  • data (integer[])(const std::vector &) bytes buffer

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:set_compression_rate (compression_rate)
Set compression rate. Encoder only.

Parameters:

  • compression_rate (number)(double) Compression rate

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:set_default_essentials ()
Set default essential EDID.

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:set_drop_packets (drop_packets_number)
Set drop packets number. Encoder only.

Parameters:

  • drop_packets_number (integer)(unsigned int) Drop packets number.

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:set_dynamic_debug (flag)
Sets dynamic debug.

Parameters:

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:set_edid_binary (file_path)
Sets the EDID of the Encoder. This function throws an exception if called when in the Decoder mode.

Parameters:

  • file_path (string)(const std::string &) Path to an EDID binary file

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:set_encoder_ip (ip)
Set encoder IP

Parameters:

Returns:

    bool true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:set_essentials (essentials)
Set essential EDID.

Parameters:

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:set_hostname (hostname)
Set device hostname.

Parameters:

  • hostname string New hostname

Returns:

    bool true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:set_media_interface (up)
Set media interface up or down.

Parameters:

  • up bool

Returns:

    bool true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:set_rx_video_mode_essentials (essentials)
Set RX video mode essentials.

Parameters:

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:set_video_bit_rate_cap (video_bit_rate_cap)
Set video bitrate cap. Encoder only.

Parameters:

  • video_bit_rate_cap (integer)(unsigned int) New video bitrate cap

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:srv_set_port (port)
KVM server set port.

Parameters:

  • port (integer)(const uint32_t &) KVM server port

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:srv_set_start ()
KVM server set start command.

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:srv_set_stop ()
KVM server set stop command.

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)
dc:start_audio_multicast (multicast_remote_ip, multicast_remote_port, local_port, audio_params)
Start the multicast audio stream.

Parameters:

  • multicast_remote_ip string Multicast IPv4 address
  • multicast_remote_port number (uint16)
  • local_port number (uint16) Remote UDP port
  • audio_params (mint.structs.mint_audio_params) Audio stream settings

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)

Usage:

    dc:start_audio_multicast(
  '192.168.2.251',
  9801,
  9801,
  {
    channels = 2;
    sample_rate = 44100;
    bits_per_sample = 24;
  }
)
dc:start_audio_unicast (remote_ip, remote_port, local_port, audio_params)
Start the unicast audio stream.

Parameters:

  • remote_ip string Remote IPv4 address
  • remote_port number (uint16) Remote UDP port
  • local_port number (uint16) Local UDP port
  • audio_params (mint.structs.mint_audio_params) Audio stream settings

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)

Usage:

    dc:start_audio_unicast(
  '192.168.2.105',
  5801,
  5801,
  {
    channels = 2;
    sample_rate = 44100;
    bits_per_sample = 24;
  }
)
dc:start_video_multicast (multicast_remote_ip, multicast_remote_port, local_port[, video_mode=mint.VIDEO_NOT_SET])
Start the multicast video stream.

Parameters:

  • multicast_remote_ip string Multicast IPv4 address
  • multicast_remote_port number (uint16) Remote UDP port
  • local_port number (uint16) Local UDP port
  • video_mode number (ubyte) Video mode (default mint.VIDEO_NOT_SET)

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)

See also:

Usage:

    dc:start_video_multicast('192.168.2.251', 9800, 9800, mint.VIDEO_4K_60)
dc:start_video_unicast (remote_ip, remote_port, local_port[, video_mode=mint.VIDEO_NOT_SET])
Start the unicast video stream.

Parameters:

  • remote_ip string Remote IPv4 address
  • remote_port number (uint16) Remote UDP port
  • local_port number (uint16) Local UDP port
  • video_mode number (ubyte) Video mode (default mint.VIDEO_NOT_SET)

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)

See also:

Usage:

    dc:start_video_unicast('192.168.2.105', 5800, 5800)
dc:stop_audio ()
Stop the audio stream.

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)

See also:

Usage:

    dc:stop_audio()
dc:stop_stream (kind)
Stop transmitting stream.

Parameters:

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)

See also:

Usage:

    dc:stop_stream(mint.STREAM_KIND_VIDEO)
dc:stop_video ()
Stop the video stream.

Returns:

    true (on success)

Or

  1. nil
  2. string Error message (on failure)

See also:

Usage:

    dc:stop_video()
generated by LDoc 1.4.6 Last updated 1980-01-01 00:00:00