OpenBroadcaster Documentation
controllers / emergency.php

Emergency

Controller

Manages emergency broadcasts, also commonly referred to as priorities or priority broadcasts.

public  get ( )

Return data about a specific emergency ID. 'manage_emergency_broadcasts' is a required permission.

Parameters
id
Returns emergency
public  search ( )

Get all priority broadcasts for a specific player ID. 'manage_emergency_broadcasts' is a required permission.

Parameters
player_id
Returns emergencies
public  set_last_player ( )

Set the last selected player so we can view emergency broadcasts for that player immediately when loading the page again some other time. This will have to be generalized for other UI elements at some point. This is a user-specific setting, so no special permissions are necessary.

Parameters
player
public  get_last_player ( )

Get the last selected player on the priority broadcasts page for the current user.

Returns player
public  save ( )

Save a new emergency broadcast. The 'user_id' is set to the currently logged in user for the new broadcast. Requires the 'manage_emergency_broadcasts' permission.

Parameters
id ID of emergency broadcast. Update a pre-existing emergency if set.
item_id ID of the media item linked to the emergency broadcast.
player_id
name
frequency
duration
start
stop
public  delete ( )

Delete an emergency broadcast. Requries the 'manage_emergency_broadcasts' permission.

Parameters
id