admin

Documentation

Index

• func ApproveFollower(w http.ResponseWriter, r *http.Request)
• func AutoUpdateForceQuit(w http.ResponseWriter, r *http.Request)
• func AutoUpdateOptions(w http.ResponseWriter, r *http.Request)
• func AutoUpdateStart(w http.ResponseWriter, r *http.Request)
• func BanIPAddress(w http.ResponseWriter, r *http.Request)
• func CreateExternalAPIUser(w http.ResponseWriter, r *http.Request)
• func CreateWebhook(w http.ResponseWriter, r *http.Request)
• func DeleteCustomEmoji(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 ExternalGetActiveViewers(integration user.ExternalAPIUser, 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 GetActiveViewers(w http.ResponseWriter, r *http.Request)
• func GetBlockedAndRejectedFollowers(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 GetFederatedActions(page int, pageSize int, w http.ResponseWriter, r *http.Request)
• func GetHardwareStats(w http.ResponseWriter, r *http.Request)
• func GetIPAddressBans(w http.ResponseWriter, r *http.Request)
• func GetLogs(w http.ResponseWriter, r *http.Request)
• func GetModerators(w http.ResponseWriter, r *http.Request)
• func GetPendingFollowRequests(w http.ResponseWriter, r *http.Request)
• func GetServerConfig(w http.ResponseWriter, r *http.Request)
• func GetVideoPlaybackMetrics(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 SendFederatedMessage(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 SetAdminPassword(w http.ResponseWriter, r *http.Request)
• func SetBrowserNotificationConfiguration(w http.ResponseWriter, r *http.Request)
• func SetChatDisabled(w http.ResponseWriter, r *http.Request)
• func SetChatJoinMessagesEnabled(w http.ResponseWriter, r *http.Request)
• func SetCustomColorVariableValues(w http.ResponseWriter, r *http.Request)
• func SetCustomJavascript(w http.ResponseWriter, r *http.Request)
• func SetCustomOfflineMessage(w http.ResponseWriter, r *http.Request)
• func SetCustomStyles(w http.ResponseWriter, r *http.Request)
• func SetDirectoryEnabled(w http.ResponseWriter, r *http.Request)
• func SetDisableSearchIndexing(w http.ResponseWriter, r *http.Request)
• func SetDiscordNotificationConfiguration(w http.ResponseWriter, r *http.Request)
• func SetEnableEstablishedChatUserMode(w http.ResponseWriter, r *http.Request)
• func SetExternalActions(w http.ResponseWriter, r *http.Request)
• func SetExtraPageContent(w http.ResponseWriter, r *http.Request)
• func SetFederationActivityPrivate(w http.ResponseWriter, r *http.Request)
• func SetFederationBlockDomains(w http.ResponseWriter, r *http.Request)
• func SetFederationEnabled(w http.ResponseWriter, r *http.Request)
• func SetFederationGoLiveMessage(w http.ResponseWriter, r *http.Request)
• func SetFederationShowEngagement(w http.ResponseWriter, r *http.Request)
• func SetFederationUsername(w http.ResponseWriter, r *http.Request)
• func SetFfmpegPath(w http.ResponseWriter, r *http.Request)
• func SetForbiddenUsernameList(w http.ResponseWriter, r *http.Request)
• func SetHideViewerCount(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 SetSocketHostOverride(w http.ResponseWriter, r *http.Request)
• func SetStreamKeys(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 SetSuggestedUsernameList(w http.ResponseWriter, r *http.Request)
• func SetTags(w http.ResponseWriter, r *http.Request)
• func SetVideoCodec(w http.ResponseWriter, r *http.Request)
• func SetVideoServingEndpoint(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 UnBanIPAddress(w http.ResponseWriter, r *http.Request)
• func UpdateMessageVisibility(w http.ResponseWriter, r *http.Request)
• func UpdateUserEnabled(w http.ResponseWriter, r *http.Request)
• func UpdateUserModerator(w http.ResponseWriter, r *http.Request)
• func UploadCustomEmoji(w http.ResponseWriter, r *http.Request)
• type ConfigValue

Functions

func ApproveFollower

func ApproveFollower(w http.ResponseWriter, r *http.Request)

ApproveFollower will approve a federated follow request.

func AutoUpdateForceQuit

func AutoUpdateForceQuit(w http.ResponseWriter, r *http.Request)

AutoUpdateForceQuit will force quit the service.

func AutoUpdateOptions

func AutoUpdateOptions(w http.ResponseWriter, r *http.Request)

AutoUpdateOptions will return what auto update options are available.

func AutoUpdateStart

func AutoUpdateStart(w http.ResponseWriter, r *http.Request)

AutoUpdateStart will begin the auto update process.

func BanIPAddress

func BanIPAddress(w http.ResponseWriter, r *http.Request)

BanIPAddress will manually ban an IP address.

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 DeleteCustomEmoji

func DeleteCustomEmoji(w http.ResponseWriter, r *http.Request)

DeleteCustomEmoji deletes a custom emoji.

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 ExternalGetActiveViewers

func ExternalGetActiveViewers(integration user.ExternalAPIUser, w http.ResponseWriter, r *http.Request)

ExternalGetActiveViewers returns currently connected clients.

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 GetActiveViewers

func GetActiveViewers(w http.ResponseWriter, r *http.Request)

GetActiveViewers returns currently connected clients.

func GetBlockedAndRejectedFollowers

func GetBlockedAndRejectedFollowers(w http.ResponseWriter, r *http.Request)

GetBlockedAndRejectedFollowers will return blocked and rejected followers.

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 GetFederatedActions

func GetFederatedActions(page int, pageSize int, w http.ResponseWriter, r *http.Request)

GetFederatedActions will return the saved list of accepted inbound federated activities.

func GetHardwareStats

func GetHardwareStats(w http.ResponseWriter, r *http.Request)

GetHardwareStats will return hardware utilization over time.

func GetIPAddressBans

func GetIPAddressBans(w http.ResponseWriter, r *http.Request)

GetIPAddressBans will return all the banned IP addresses.

func GetLogs

func GetLogs(w http.ResponseWriter, r *http.Request)

GetLogs will return all logs.

func GetModerators

func GetModerators(w http.ResponseWriter, r *http.Request)

GetModerators will return a list of moderator users.

func GetPendingFollowRequests

func GetPendingFollowRequests(w http.ResponseWriter, r *http.Request)

GetPendingFollowRequests will return a list of pending follow requests.

func GetServerConfig

func GetServerConfig(w http.ResponseWriter, r *http.Request)

GetServerConfig gets the config details of the server.

func GetVideoPlaybackMetrics

func GetVideoPlaybackMetrics(w http.ResponseWriter, r *http.Request)

GetVideoPlaybackMetrics returns video playback metrics.

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 SendFederatedMessage

func SendFederatedMessage(w http.ResponseWriter, r *http.Request)

SendFederatedMessage will send a manual message to the fediverse.

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 SetAdminPassword

func SetAdminPassword(w http.ResponseWriter, r *http.Request)

SetAdminPassword will handle the web config request to set the server admin password.

func SetBrowserNotificationConfiguration

func SetBrowserNotificationConfiguration(w http.ResponseWriter, r *http.Request)

SetBrowserNotificationConfiguration will set the browser notification configuration.

func SetChatDisabled

func SetChatDisabled(w http.ResponseWriter, r *http.Request)

SetChatDisabled will disable chat functionality.

func SetChatJoinMessagesEnabled

func SetChatJoinMessagesEnabled(w http.ResponseWriter, r *http.Request)

SetChatJoinMessagesEnabled will enable or disable the chat join messages.

func SetCustomColorVariableValues

func SetCustomColorVariableValues(w http.ResponseWriter, r *http.Request)

SetCustomColorVariableValues sets the custom color variables.

func SetCustomJavascript

func SetCustomJavascript(w http.ResponseWriter, r *http.Request)

SetCustomJavascript will set the Javascript string we insert into the page.

func SetCustomOfflineMessage

func SetCustomOfflineMessage(w http.ResponseWriter, r *http.Request)

SetCustomOfflineMessage will set a message to display when the server is offline.

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 SetDisableSearchIndexing

func SetDisableSearchIndexing(w http.ResponseWriter, r *http.Request)

SetDisableSearchIndexing will set search indexing support.

func SetDiscordNotificationConfiguration

func SetDiscordNotificationConfiguration(w http.ResponseWriter, r *http.Request)

SetDiscordNotificationConfiguration will set the discord notification configuration.

func SetEnableEstablishedChatUserMode

func SetEnableEstablishedChatUserMode(w http.ResponseWriter, r *http.Request)

SetEnableEstablishedChatUserMode sets the requirement for a chat user to be "established" for some time before taking part in chat.

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 SetFederationActivityPrivate

func SetFederationActivityPrivate(w http.ResponseWriter, r *http.Request)

SetFederationActivityPrivate will set if Federation features are private to followers.

func SetFederationBlockDomains

func SetFederationBlockDomains(w http.ResponseWriter, r *http.Request)

SetFederationBlockDomains saves a list of domains to block on the Fediverse.

func SetFederationEnabled

func SetFederationEnabled(w http.ResponseWriter, r *http.Request)

SetFederationEnabled will set if Federation features are enabled.

func SetFederationGoLiveMessage

func SetFederationGoLiveMessage(w http.ResponseWriter, r *http.Request)

SetFederationGoLiveMessage will set the federated message sent when the streamer goes live.

func SetFederationShowEngagement

func SetFederationShowEngagement(w http.ResponseWriter, r *http.Request)

SetFederationShowEngagement will set if Fedivese engagement shows in chat.

func SetFederationUsername

func SetFederationUsername(w http.ResponseWriter, r *http.Request)

SetFederationUsername will set the local actor username used for federation activities.

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 SetHideViewerCount

func SetHideViewerCount(w http.ResponseWriter, r *http.Request)

SetHideViewerCount will enable or disable hiding the viewer count.

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 SetSocketHostOverride

func SetSocketHostOverride(w http.ResponseWriter, r *http.Request)

SetSocketHostOverride will set the host override for the websocket.

func SetStreamKeys

func SetStreamKeys(w http.ResponseWriter, r *http.Request)

SetStreamKeys will set the valid stream keys.

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 SetSuggestedUsernameList

func SetSuggestedUsernameList(w http.ResponseWriter, r *http.Request)

SetSuggestedUsernameList will set the list of suggested usernames that newly registered users are assigned if it isn't inferred otherwise (i.e. through a proxy).

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 SetVideoServingEndpoint

func SetVideoServingEndpoint(w http.ResponseWriter, r *http.Request)

SetVideoServingEndpoint will save the video serving endpoint.

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 UnBanIPAddress

func UnBanIPAddress(w http.ResponseWriter, r *http.Request)

UnBanIPAddress will remove an IP address ban.

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.

func UpdateUserModerator

func UpdateUserModerator(w http.ResponseWriter, r *http.Request)

UpdateUserModerator will set the moderator status for a user ID.

func UploadCustomEmoji

func UploadCustomEmoji(w http.ResponseWriter, r *http.Request)

UploadCustomEmoji allows POSTing a new custom emoji to the server.

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.