OpenBroadcaster Documentation
controllers / shows.php

Shows

Controller

Shows controller manages single scheduled timeslot items.

public  get ( )

Get an individual scheduled show.

Parameters
id
Returns show
public  get_recurring ( )

Get an individual recurring scheduled show.

Parameters
id
Returns show.
public  search ( )

Get shows between two given dates/times. This function is used for the UI/API, but also to detect potential scheduling collisions.

Parameters
start
end
player
Returns shows
public  set_last_player ( )

Set the last selected player so we can view schedules 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 schedules page for the current user.

Returns player
public  delete ( )

Delete a scheduled show. Requires 'manage_timeslots' unless the show is owned by the user.

Parameters
id
recurring
public  save ( )

Edit or save a new show.

Parameters
id Optional when saving a new show.
edit_recurring Boolean specifying whether or not we're editing a recurring show.
player_id
mode One time, or every X interval.
x_data When mode is set to an interval, x_data specifies every X.
start
duration
stop
item_type
item_id