Commands

This page includes all the commands that can be executed by users and admins

User Commands

---

/stopvideo

This command has to be enabled from the Config. It allows any user to stop only they're current playing video

config.lua

Config.UserCommands = { -- If set to false, the command can only be executed by users in the groups listed above
    StopLocalVideo = true, -- Enables the /stopvideo command for the users
    StopGlobalVideo = false, -- Enables the /stopvideo all command for the users
}

Admin Commands

---

/playvideo

This command allows admins to play a video globally or for a specific group of players. It takes 3 parameters:

• VideoURL: String (Required) The URL of the video to play. It can be either a direct video link (ex. www.example.com/video.mp4) or a YouTube URL. Note that the YouTube implementation uses the official YouTube API, so certain videos may cause problems or not start due to the copyright restiction policies of the YouTube API.

• Volume: Integer (Optional) Default: 50 This has to be an integer value between 1 and 100. It may not work on the YouTube Player, we are currently working for a fix.

• ShowDialog: Boolean (Optional) Default: Config.EnablePlayDialog or True This has to be a boolean value (1 and 0 can be used too, they will be converted to boolean automatically). Allows you to show or bypass the alert dialog that asks the user to allow or deny the current video transmission. The defautl value references to the Config.EnablePlayDialog value, which is True by default.

• PlayerID: Integer | GroupName: String | None (Optional) Default: None This can be either a PlayerID (Source) to play the video only to a specific player, a GroupName, to send the play event to all online players of the specific group, or a nil value to play the video globally to all the current online players

/stopvideo

This command, executed by an admin, has 1 parameter that can be passed. It allows you to stop a playing video for yourself, a specific player (or players based on group) or to all the players online

• PlayerID: Integer | GroupName or All: String | None (Optional) Default: None Stops the current video for the specific PlayerID (If the parameter passed is an integer), for a specific group of player or to all the online players if the string "all" is passed (If the parameter passed is a string) or for yourself if nothing is passed.

/videoviews

Send you a notification with the number of players who viewed the previous video (The command is enabled only if Config.EnablePlayDialog is set to true). The returned notification will contain the number of the players who accepted the video