Documentation
¶
Index ¶
- func CreateExternalAPIUser(w http.ResponseWriter, r *http.Request)
- func CreateWebhook(w http.ResponseWriter, r *http.Request)
- func DeleteExternalAPIUser(w http.ResponseWriter, r *http.Request)
- func DeleteWebhook(w http.ResponseWriter, r *http.Request)
- func DisconnectInboundConnection(w http.ResponseWriter, r *http.Request)
- func ExternalGetConnectedChatClients(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
- func ExternalSetStreamTitle(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
- func ExternalUpdateMessageVisibility(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
- func GetChatMessages(w http.ResponseWriter, r *http.Request)
- func GetConnectedChatClients(w http.ResponseWriter, r *http.Request)
- func GetDisabledUsers(w http.ResponseWriter, r *http.Request)
- func GetExternalAPIUsers(w http.ResponseWriter, r *http.Request)
- func GetHardwareStats(w http.ResponseWriter, r *http.Request)
- func GetLogs(w http.ResponseWriter, r *http.Request)
- func GetServerConfig(w http.ResponseWriter, r *http.Request)
- func GetViewersOverTime(w http.ResponseWriter, r *http.Request)
- func GetWarnings(w http.ResponseWriter, r *http.Request)
- func GetWebhooks(w http.ResponseWriter, r *http.Request)
- func ResetYPRegistration(w http.ResponseWriter, r *http.Request)
- func SendChatAction(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
- func SendIntegrationChatMessage(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
- func SendSystemMessage(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
- func SendSystemMessageToConnectedClient(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
- func SendUserMessage(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
- func ServeAdmin(w http.ResponseWriter, r *http.Request)
- func SetChatDisabled(w http.ResponseWriter, r *http.Request)
- func SetCustomStyles(w http.ResponseWriter, r *http.Request)
- func SetDirectoryEnabled(w http.ResponseWriter, r *http.Request)
- func SetExternalActions(w http.ResponseWriter, r *http.Request)
- func SetExtraPageContent(w http.ResponseWriter, r *http.Request)
- func SetFfmpegPath(w http.ResponseWriter, r *http.Request)
- func SetForbiddenUsernameList(w http.ResponseWriter, r *http.Request)
- func SetLogo(w http.ResponseWriter, r *http.Request)
- func SetNSFW(w http.ResponseWriter, r *http.Request)
- func SetRTMPServerPort(w http.ResponseWriter, r *http.Request)
- func SetS3Configuration(w http.ResponseWriter, r *http.Request)
- func SetServerName(w http.ResponseWriter, r *http.Request)
- func SetServerSummary(w http.ResponseWriter, r *http.Request)
- func SetServerURL(w http.ResponseWriter, r *http.Request)
- func SetServerWelcomeMessage(w http.ResponseWriter, r *http.Request)
- func SetSocialHandles(w http.ResponseWriter, r *http.Request)
- func SetStreamKey(w http.ResponseWriter, r *http.Request)
- func SetStreamLatencyLevel(w http.ResponseWriter, r *http.Request)
- func SetStreamOutputVariants(w http.ResponseWriter, r *http.Request)
- func SetStreamTitle(w http.ResponseWriter, r *http.Request)
- func SetTags(w http.ResponseWriter, r *http.Request)
- func SetVideoCodec(w http.ResponseWriter, r *http.Request)
- func SetWebServerIP(w http.ResponseWriter, r *http.Request)
- func SetWebServerPort(w http.ResponseWriter, r *http.Request)
- func Status(w http.ResponseWriter, r *http.Request)
- func UpdateMessageVisibility(w http.ResponseWriter, r *http.Request)
- func UpdateUserEnabled(w http.ResponseWriter, r *http.Request)
- type ConfigValue
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateExternalAPIUser ¶
func CreateExternalAPIUser(w http.ResponseWriter, r *http.Request)
CreateExternalAPIUser will generate a 3rd party access token.
func CreateWebhook ¶
func CreateWebhook(w http.ResponseWriter, r *http.Request)
CreateWebhook will add a single webhook.
func DeleteExternalAPIUser ¶
func DeleteExternalAPIUser(w http.ResponseWriter, r *http.Request)
DeleteExternalAPIUser will return a single 3rd party access token.
func DeleteWebhook ¶
func DeleteWebhook(w http.ResponseWriter, r *http.Request)
DeleteWebhook will delete a single webhook.
func DisconnectInboundConnection ¶
func DisconnectInboundConnection(w http.ResponseWriter, r *http.Request)
DisconnectInboundConnection will force-disconnect an inbound stream.
func ExternalGetConnectedChatClients ¶
func ExternalGetConnectedChatClients(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
ExternalGetConnectedChatClients returns currently connected clients.
func ExternalSetStreamTitle ¶
func ExternalSetStreamTitle(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
ExternalSetStreamTitle will change the stream title on behalf of an external integration API request.
func ExternalUpdateMessageVisibility ¶
func ExternalUpdateMessageVisibility(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
ExternalUpdateMessageVisibility updates an array of message IDs to have the same visiblity.
func GetChatMessages ¶
func GetChatMessages(w http.ResponseWriter, r *http.Request)
GetChatMessages returns all of the chat messages, unfiltered.
func GetConnectedChatClients ¶
func GetConnectedChatClients(w http.ResponseWriter, r *http.Request)
GetConnectedChatClients returns currently connected clients.
func GetDisabledUsers ¶
func GetDisabledUsers(w http.ResponseWriter, r *http.Request)
GetDisabledUsers will return all the disabled users.
func GetExternalAPIUsers ¶
func GetExternalAPIUsers(w http.ResponseWriter, r *http.Request)
GetExternalAPIUsers will return all 3rd party access tokens.
func GetHardwareStats ¶
func GetHardwareStats(w http.ResponseWriter, r *http.Request)
GetHardwareStats will return hardware utilization over time.
func GetServerConfig ¶
func GetServerConfig(w http.ResponseWriter, r *http.Request)
GetServerConfig gets the config details of the server.
func GetViewersOverTime ¶
func GetViewersOverTime(w http.ResponseWriter, r *http.Request)
GetViewersOverTime will return the number of viewers at points in time.
func GetWarnings ¶
func GetWarnings(w http.ResponseWriter, r *http.Request)
GetWarnings will return only warning and error logs.
func GetWebhooks ¶
func GetWebhooks(w http.ResponseWriter, r *http.Request)
GetWebhooks will return all webhooks.
func ResetYPRegistration ¶
func ResetYPRegistration(w http.ResponseWriter, r *http.Request)
ResetYPRegistration will clear the YP protocol registration key.
func SendChatAction ¶
func SendChatAction(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
SendChatAction will send a generic chat action.
func SendIntegrationChatMessage ¶
func SendIntegrationChatMessage(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
SendIntegrationChatMessage will send a chat message on behalf of an external chat integration.
func SendSystemMessage ¶
func SendSystemMessage(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
SendSystemMessage will send an official "SYSTEM" message to chat on behalf of your server.
func SendSystemMessageToConnectedClient ¶
func SendSystemMessageToConnectedClient(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
SendSystemMessageToConnectedClient will handle incoming requests to send a single message to a single connected client by ID.
func SendUserMessage ¶
func SendUserMessage(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)
SendUserMessage will send a message to chat on behalf of a user. *Depreciated*.
func ServeAdmin ¶
func ServeAdmin(w http.ResponseWriter, r *http.Request)
ServeAdmin will return admin web assets.
func SetChatDisabled ¶
func SetChatDisabled(w http.ResponseWriter, r *http.Request)
SetChatDisabled will disable chat functionality.
func SetCustomStyles ¶
func SetCustomStyles(w http.ResponseWriter, r *http.Request)
SetCustomStyles will set the CSS string we insert into the page.
func SetDirectoryEnabled ¶
func SetDirectoryEnabled(w http.ResponseWriter, r *http.Request)
SetDirectoryEnabled will handle the web config request to enable or disable directory registration.
func SetExternalActions ¶
func SetExternalActions(w http.ResponseWriter, r *http.Request)
SetExternalActions will set the 3rd party actions for the web interface.
func SetExtraPageContent ¶
func SetExtraPageContent(w http.ResponseWriter, r *http.Request)
SetExtraPageContent will handle the web config request to set the page markdown content.
func SetFfmpegPath ¶
func SetFfmpegPath(w http.ResponseWriter, r *http.Request)
SetFfmpegPath will handle the web config request to validate and set an updated copy of ffmpg.
func SetForbiddenUsernameList ¶
func SetForbiddenUsernameList(w http.ResponseWriter, r *http.Request)
SetForbiddenUsernameList will set the list of usernames we do not allow to use.
func SetLogo ¶
func SetLogo(w http.ResponseWriter, r *http.Request)
SetLogo will handle a new logo image file being uploaded.
func SetNSFW ¶
func SetNSFW(w http.ResponseWriter, r *http.Request)
SetNSFW will handle the web config request to set the NSFW flag.
func SetRTMPServerPort ¶
func SetRTMPServerPort(w http.ResponseWriter, r *http.Request)
SetRTMPServerPort will handle the web config request to set the inbound RTMP port.
func SetS3Configuration ¶
func SetS3Configuration(w http.ResponseWriter, r *http.Request)
SetS3Configuration will handle the web config request to set the storage configuration.
func SetServerName ¶
func SetServerName(w http.ResponseWriter, r *http.Request)
SetServerName will handle the web config request to set the server's name.
func SetServerSummary ¶
func SetServerSummary(w http.ResponseWriter, r *http.Request)
SetServerSummary will handle the web config request to set the about/summary text.
func SetServerURL ¶
func SetServerURL(w http.ResponseWriter, r *http.Request)
SetServerURL will handle the web config request to set the full server URL.
func SetServerWelcomeMessage ¶
func SetServerWelcomeMessage(w http.ResponseWriter, r *http.Request)
SetServerWelcomeMessage will handle the web config request to set the welcome message text.
func SetSocialHandles ¶
func SetSocialHandles(w http.ResponseWriter, r *http.Request)
SetSocialHandles will handle the web config request to set the external social profile links.
func SetStreamKey ¶
func SetStreamKey(w http.ResponseWriter, r *http.Request)
SetStreamKey will handle the web config request to set the server stream key.
func SetStreamLatencyLevel ¶
func SetStreamLatencyLevel(w http.ResponseWriter, r *http.Request)
SetStreamLatencyLevel will handle the web config request to set the stream latency level.
func SetStreamOutputVariants ¶
func SetStreamOutputVariants(w http.ResponseWriter, r *http.Request)
SetStreamOutputVariants will handle the web config request to set the video output stream variants.
func SetStreamTitle ¶
func SetStreamTitle(w http.ResponseWriter, r *http.Request)
SetStreamTitle will handle the web config request to set the current stream title.
func SetTags ¶
func SetTags(w http.ResponseWriter, r *http.Request)
SetTags will handle the web config request to set tags.
func SetVideoCodec ¶
func SetVideoCodec(w http.ResponseWriter, r *http.Request)
SetVideoCodec will change the codec used for video encoding.
func SetWebServerIP ¶
func SetWebServerIP(w http.ResponseWriter, r *http.Request)
SetWebServerIP will handle the web config request to set the server's HTTP listen address.
func SetWebServerPort ¶
func SetWebServerPort(w http.ResponseWriter, r *http.Request)
SetWebServerPort will handle the web config request to set the server's HTTP port.
func Status ¶
func Status(w http.ResponseWriter, r *http.Request)
Status gets the details of the inbound broadcaster.
func UpdateMessageVisibility ¶
func UpdateMessageVisibility(w http.ResponseWriter, r *http.Request)
UpdateMessageVisibility updates an array of message IDs to have the same visiblity.
func UpdateUserEnabled ¶
func UpdateUserEnabled(w http.ResponseWriter, r *http.Request)
UpdateUserEnabled enable or disable a single user by ID.
Types ¶
type ConfigValue ¶
type ConfigValue struct {
Value interface{} `json:"value"`
}
ConfigValue is a container object that holds a value, is encoded, and saved to the database.
Source Files