bytehive-playoutbee

ByteHive PlayoutBee

Companion module to control ByteHive's PlayoutBee media player. Currently supports featurs up to PlayoutBee 0.9.3.

Configuration

The module provides the ability to configure thae following options:

1. PlayoutBee IP - The IP Address if the device running PlayoutBee
2. PlayoutBee REST Port - The TCP port number on which PlayoutBee listens for RESTful API commands (at the moment, PlayoutBee only uses port 3000)
3. Polling Interval in Milliseconds - The number of milliseconds the module waits between API calls to Playout Bee (defaults to 100ms, but you can increase up to 1000ms)

Actions

The actions available in this module mimic those available in the PlayoutBee REST API.

1. Play - Play the current clip
2. Pause - Pause the current clip
3. Stop - Stop the current clip
4. Next - Select the next clip (NOTE: if the last clip is already selected it wraps and selects the first clip)
5. Select Clip - Select a specific clip from a dropdown list
6. Set Loop - Turn on, turn off or toggle the clip loop feature

Feedbacks

The module provides the ability to set button feedback based on the following conditions:

1. Current Clip - Select the clip you want to provide feedback for
2. Player Status - Feedback depends on whether PlayoutBee is playing, stopped or paused.
3. Loop Status - Feedback depends on whether the Loop clip setting isn on or off.

Variables

The following variables are vailable for use:

1. clip_id - The number of the currently selected clip
2. clip_name - The file name of the currently selected clip
3. status - The player status
4. loop - The player loop setting status
5. timecode - The timecode of the current clip
6. timecode_hh - The hours part of timecode
7. timecode_mm - The minutes part of timecode
8. timecode_ss - The seconds part of timecode
9. timecode_ff - The frames part of timecode
10. remaining_timecode - The time remaining of the current clip
11. remaining_hh - The hours part of remaining_timecode
12. remaining_mm - The minutes part of remaining_timecode
13. remaining_ss - The seconds part of remaining_timecode
14. remaining_ff - The fraction part of remaining_timecode (NOTE: This is fraction and not frames because PlayoutBee doesn't report remaining frames)