Skip to content

Take control over your live stream video by running it yourself. Streaming + chat out of the box.

6.1 KB
Raw Blame
{
  "permissions": {
    "PermAuthGate": "auth.gate",
    "PermChatFilter": "chat.filter",
    "PermChatHistory": "chat.history",
    "PermChatModerate": "chat.moderate",
    "PermChatSend": "chat.send",
    "PermEmitEvent": "events.emit",
    "PermFediverseInbound": "fediverse.inbound",
    "PermFediversePost": "fediverse.post",
    "PermHttpSSE": "http.sse",
    "PermHttpServe": "http.serve",
    "PermNetworkFetch": "network.fetch",
    "PermNotificationsSend": "notifications.send",
    "PermServerRead": "server.read",
    "PermStorageFS": "storage.fs",
    "PermStorageKV": "storage.kv",
    "PermStorageSQL": "storage.sql",
    "PermStorageUpload": "storage.upload",
    "PermUIModify": "ui.modify",
    "PermUsersModerate": "users.moderate",
    "PermUsersRead": "users.read",
    "PermUsersRegister": "users.register",
    "PermVideoConfigRead": "videoconfig.read",
    "PermVideoConfigWrite": "videoconfig.write"
  },
  "hostFunctions": [
    "owncast_add_actions",
    "owncast_asset_read",
    "owncast_auth_end_session",
    "owncast_auth_grant_session",
    "owncast_ban_ip",
    "owncast_chat_clients",
    "owncast_chat_history",
    "owncast_clear_actions",
    "owncast_config_get",
    "owncast_delete_message",
    "owncast_emit_event",
    "owncast_fediverse_post",
    "owncast_fs_delete",
    "owncast_fs_exists",
    "owncast_fs_list",
    "owncast_fs_read",
    "owncast_fs_write",
    "owncast_kick_client",
    "owncast_kv_get",
    "owncast_kv_set",
    "owncast_log_error",
    "owncast_log_info",
    "owncast_log_warning",
    "owncast_notify_browser_push",
    "owncast_notify_discord",
    "owncast_notify_fediverse",
    "owncast_send_chat",
    "owncast_send_chat_action",
    "owncast_send_chat_system",
    "owncast_send_chat_to",
    "owncast_server_emotes",
    "owncast_server_federation",
    "owncast_server_info",
    "owncast_server_socials",
    "owncast_server_tags",
    "owncast_sql_exec",
    "owncast_sql_query",
    "owncast_sse_send",
    "owncast_storage_upload",
    "owncast_stream_broadcaster",
    "owncast_stream_current",
    "owncast_timer_clear",
    "owncast_timer_set",
    "owncast_user_get",
    "owncast_user_set_enabled",
    "owncast_users_list",
    "owncast_users_register",
    "owncast_video_config_read",
    "owncast_video_config_write"
  ],
  "wireTypes": {
    "ActionResult": {
      "error": "string"
    },
    "BrowserPushPayload": {
      "body": "string",
      "title": "string",
      "url": "string"
    },
    "CommandEvent": {
      "argString": "string",
      "args": "[]string",
      "command": "string",
      "invokedAs": "string",
      "message": "HostChatMessage"
    },
    "CommandInfo": {
      "aliases": "[]string",
      "caseSensitive": "bool",
      "cooldownMs": "int64",
      "description": "string",
      "modOnly": "bool",
      "name": "string",
      "prefix": "string",
      "usage": "string"
    },
    "Emote": {
      "name": "string",
      "url": "string"
    },
    "FSResult": {
      "error": "string"
    },
    "FederationInfo": {
      "enabled": "bool",
      "isPrivate": "bool",
      "username": "string"
    },
    "FediversePayload": {
      "body": "string",
      "image": "string",
      "link": "string",
      "type": "string"
    },
    "GrantSessionRequest": {
      "ttl": "int64",
      "userId": "string"
    },
    "GrantSessionResult": {
      "error": "string"
    },
    "HostChatClient": {
      "connectedAt": "string",
      "displayName": "string",
      "id": "uint64",
      "ipAddress": "string",
      "messageCount": "int",
      "userAgent": "string",
      "userId": "string"
    },
    "HostChatMessage": {
      "body": "string",
      "clientId": "uint64",
      "id": "string",
      "timestamp": "string",
      "user": "*HostUser"
    },
    "HostUser": {
      "createdAt": "string",
      "disabledAt": "string",
      "displayColor": "int",
      "displayName": "string",
      "id": "string",
      "isAuthenticated": "bool",
      "isBot": "bool",
      "previousNames": "[]string",
      "scopes": "[]string"
    },
    "SQLExecResult": {
      "error": "string",
      "lastInsertId": "int64",
      "rowsAffected": "int64"
    },
    "SQLQueryResult": {
      "columns": "[]string",
      "error": "string",
      "rows": "[][]any",
      "truncated": "bool"
    },
    "SQLRequest": {
      "maxRows": "int",
      "params": "[]any",
      "sql": "string"
    },
    "SSEConnectionEvent": {
      "channel": "string",
      "connectionId": "uint64",
      "user": "*HostUser"
    },
    "ServerInfo": {
      "name": "string",
      "summary": "string",
      "url": "string",
      "version": "string",
      "welcomeMessage": "string"
    },
    "SocialHandle": {
      "icon": "string",
      "platform": "string",
      "url": "string"
    },
    "StreamBroadcaster": {
      "bitrates": "[]int",
      "codecs": "[]string",
      "framerate": "int",
      "remoteAddr": "string",
      "resolution": "string"
    },
    "StreamInfo": {
      "latencyLevel": "int",
      "online": "bool",
      "startedAt": "string",
      "summary": "string",
      "title": "string",
      "viewers": "int"
    },
    "StreamVariant": {
      "cpuUsageLevel": "int",
      "framerate": "int",
      "height": "int",
      "isPassthrough": "bool",
      "videoBitrate": "int",
      "width": "int"
    },
    "TickEvent": {
      "now": "int64"
    },
    "TimerFireEvent": {
      "id": "uint64"
    },
    "UploadResult": {
      "url": "string"
    },
    "UserRegisterRequest": {
      "authId": "string",
      "displayName": "string",
      "handle": "string",
      "profileUrl": "string",
      "public": "bool",
      "scopes": "[]string"
    },
    "UserRegisterResult": {
      "error": "string",
      "userId": "string"
    },
    "VideoConfig": {
      "autoplay": "models.AutoplayMode",
      "codec": "string",
      "latencyLevel": "int",
      "variants": "[]StreamVariant"
    },
    "VideoConfigUpdate": {
      "autoplay": "*models.AutoplayMode",
      "codec": "*string",
      "latencyLevel": "*int",
      "variants": "[]StreamVariant"
    },
    "VideoConfigWriteResult": {
      "error": "string"
    }
  }
}