GRPC

Services

AuthenticationService

The Authentication Service provides token services for clients

Method Name	Request Type	Response Type	Description
CreateGuestAccessToken	CreateGuestAccessTokenRequest	CreateGuestAccessTokenResponse	Create Guest Access Token Create an access token for a guest
RefreshAccessToken	RefreshAccessTokenRequest	RefreshAccessTokenResponse	Refresh Access Token Forcibly refresh an access token prior to expiration
CreateWebRtcAccessToken	CreateWebRtcAccessTokenRequest	CreateWebRtcAccessTokenResponse	Create WebRTC Access Token Create a WebRTC Access Token

BackendAuthenticationService

The Backend Authentication Service provides token services for partner backend systems

Method Name	Request Type	Response Type	Description
CreateAccessToken	CreateAccessTokenRequest	CreateAccessTokenResponse	Create Access Token Create an access token for a session host

CollectionService

The Collection Service operates on collections, which contain projects and collection live sources used in projects.

Method Name	Request Type	Response Type	Description
CreateCollection	CreateCollectionRequest	CreateCollectionResponse	Create Collection Create a new collection of related projects and collection live sources
GetCollection	GetCollectionRequest	GetCollectionResponse	Get Collection Get an existing collection of related projects and collection live sources
GetCollections	GetCollectionsRequest	GetCollectionsResponse	Get Collections Get all collections owned by the user
UpdateCollection	UpdateCollectionRequest	UpdateCollectionResponse	Update Collection Update select collection document data
DeleteCollection	DeleteCollectionRequest	DeleteCollectionResponse	Delete Collection Delete a collection of related projects and collection live sources

DestinationService

The Destination Service operates on Project Destinations. Destinations designate where a Broadcast associated with a Project is distributed downstream.

Method Name	Request Type	Response Type	Description
CreateDestination	CreateDestinationRequest	CreateDestinationResponse	Create Destination Create a new Destination
GetDestination	GetDestinationRequest	GetDestinationResponse	Get Destination Get an existing Destination.
UpdateDestination	UpdateDestinationRequest	UpdateDestinationResponse	Update Destination Update a destination
DeleteDestination	DeleteDestinationRequest	DeleteDestinationResponse	Delete Destination Delete a destination

ProjectService

The Project Service operates on a Project.

Method Name	Request Type	Response Type	Description
CreateProject	CreateProjectRequest	CreateProjectResponse	Create Project Create a new project
GetProject	GetProjectRequest	GetProjectResponse	Get Project Get an existing project
DeleteProject	DeleteProjectRequest	DeleteProjectResponse	Delete Project Delete a project
UpdateProject	UpdateProjectRequest	UpdateProjectResponse	Update Project Updates a project
StartProjectBroadcast	StartProjectBroadcastRequest	StartProjectBroadcastResponse	Start Broadcast Start broadcasting a project
StopProjectBroadcast	StopProjectBroadcastRequest	StopProjectBroadcastResponse	Stop Broadcast Stop broadcasting a project
StartProjectWebRtc	StartProjectWebRtcRequest	StartProjectWebRtcResponse	Start WebRTC Start WebRTC services
StopProjectWebRtc	StopProjectWebRtcRequest	StopProjectWebRtcResponse	Stop WebRTC Stop WebRTC services
GetProjectBroadcastSnapshot	GetProjectBroadcastSnapshotRequest	GetProjectBroadcastSnapshotResponse	Get Snapshot Get a snapshot of the current output frame of the broadcast
GetProjectBroadcastStatus	GetProjectBroadcastStatusRequest	GetProjectBroadcastStatusResponse	Get Broadcast Status Get the broadcast status of the project

PublicAuthenticationService

The Public Authentication Service provides token verification services

Method Name	Request Type	Response Type	Description
GetJsonWebKeySet	GetJsonWebKeySetRequest	GetJsonWebKeySetResponse	Get Public Keys Get public keys used to sign access tokens
GuestCodeRedirect	GuestCodeRedirectRequest	GuestCodeRedirectResponse	Exchange Guest Access Token Exchange a guest access token with updated user identifiers

SourceService

The Source Service operates on Collection Live Sources and Project Sources.

Method Name	Request Type	Response Type	Description
CreateSource	CreateSourceRequest	CreateSourceResponse	Create Collection Live Source Create a new live source in a collection ### Permissions * scope: SCOPE_VAPI_CREATE
DeleteSource	DeleteSourceRequest	DeleteSourceResponse	Delete Live Source Deletes a live source from a collection
UpdateSource	UpdateSourceRequest	UpdateSourceResponse	Update Source Update attributes of the Source.
UpdateSourceInProject	UpdateSourceInProjectRequest	UpdateSourceInProjectResponse	Update Source Update attributes of the Source.
GetSource	GetSourceRequest	GetSourceResponse	Get Source Get an existing source in a project
GetSources	GetSourcesRequest	GetSourcesResponse	Get Source Get existing sources in a collection
AddSourceToProject	AddSourceToProjectRequest	AddSourceToProjectResponse	Add Source to Project Add a source to a project
RemoveSourceFromProject	RemoveSourceFromProjectRequest	RemoveSourceFromProjectResponse	Delete Source From Project Removes a source from a project.

Messages

AddSourceToProjectRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project which will own the source
source_id	string		live source id
trigger	SourceTrigger	optional	allow this source to trigger a project broadcast

AddSourceToProjectResponse

Field	Type	Label	Description
project	Project		updated project
broadcast_updated	bool		indicates whether the broadcast was updated as a function of this request

AudioEncoding

encoding audio parameters

Field	Type	Label	Description
codec	AudioCodec	optional	audio encoding codec

AudioRendering

composition audio parameters

Field	Type	Label	Description
channel_layout	AudioChannelLayout	optional	audio channel layout

Collection

a Collection of Projects and Sources

Field	Type	Label	Description
collection_id	string		collection id
metadata	google.protobuf.Value	optional	arbitrary metadata associated with this collection
projects	Project	repeated	projects owned by this collection
sources	Source	repeated	collection live sources owned by this collection

CollectionCreateEvent

a collection was created

Field	Type	Label	Description
collection_id	string		collection id
collection	Collection		the new collection

CollectionDeleteEvent

a collection was deleted

Field	Type	Label	Description
collection_id	string		collection id

CollectionEvent

Field	Type	Label	Description
create	CollectionCreateEvent
update	CollectionUpdateEvent
delete	CollectionDeleteEvent

CollectionUpdateEvent

a collection was updated

Field	Type	Label	Description
collection_id	string		collection id
update_mask	string	repeated	the fields which were updated
collection	Collection		the updated collection

Composition

composition source for project (select one)

Field	Type	Label	Description
external	ExternalComposition		compose using an external renderer
studio_sdk	StudioSdkComposition		compose using the studiosdk renderer
scene	SceneComposition		compose scenes using the browser-based compositor

CreateAccessTokenRequest

Field	Type	Label	Description
service_user_id	string		service-specific user id ### Usage * this should be an opaque GUID with no spaces
display_name	string	optional
role	Role	optional	the requested role
max_duration	uint32	optional	requested duration of token before it expires (ms)

CreateAccessTokenResponse

Field	Type	Label	Description
access_token	string		access token for owner to be asserted in subsequent Video and Layout API calls

CreateCollectionRequest

Field	Type	Label	Description
metadata	google.protobuf.Value	optional	arbitrary metadata to associate with this collection

CreateCollectionResponse

Field	Type	Label	Description
collection	Collection

CreateDestinationRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the destination
project_id	string		project which will own this destination
metadata	google.protobuf.Value	optional	arbitrary metadata associated with this destination
address	DestinationAddress		destination address (select one)
enabled	bool	optional	enable or disable this destination
timeout	uint32	optional	timeout (in milliseconds) to wait before resetting a connection

CreateDestinationResponse

Field	Type	Label	Description
destination	Destination		the newly created destination

CreateGuestAccessTokenRequest

Field	Type	Label	Description
collection_id	string		id of the collection this token is allowed to access
project_id	string		id of the project this token is allowed to access
max_duration	uint32	optional	requested duration (ms) of token before it expires
role	Role		the requested role of the guest
token	GuestAccessToken		the type of token
url	string	optional	request a shortened url

CreateGuestAccessTokenResponse

Field	Type	Label	Description
access_token	string		access token for guest to be used in subsequent API calls
url	string	optional	the shortened url

CreateProjectRequest

Field	Type	Label	Description
collection_id	string		collection which will own this project
metadata	google.protobuf.Value	optional	arbitrary metadata to associate with this project
rendering	Rendering	optional	composition parameters
encoding	Encoding	optional	encoding parameters
composition	Composition		composition/layout source of the broadcast
max_duration	uint32	optional	maximum duration of project broadcasts (ms)
webrtc	WebRtc	optional	request webrtc services
location	LatLong	optional	optimal broadcast location (for routing and delay)

CreateProjectResponse

Field	Type	Label	Description
project	Project

CreateSourceRequest

Field	Type	Label	Description
collection_id	string		collection which will own this collection live source
metadata	google.protobuf.Value	optional	arbitrary metadata to associate with this collection live source
address	SourceAddress		type of collection live source
preview	PreviewAddress	optional	enable real-time previews

CreateSourceResponse

Field	Type	Label	Description
source	Source

CreateWebRtcAccessTokenRequest

Field	Type	Label	Description
collection_id	string		id of the collection this token is allowed to access
project_id	string		id of the project this token is allowed to access
display_name	string		display name of the guest (used to generate webrtc particpant name)

CreateWebRtcAccessTokenResponse

Field	Type	Label	Description
webrtc_access	WebRtcAccess		the webrtc token parameters

DeleteCollectionRequest

Field	Type	Label	Description
collection_id	string		collection id
force	bool	optional	forcibly end all child project broadcasts in progress

DeleteCollectionResponse

Field	Type	Label	Description
sources_deleted	uint32		number of live sources owned by this collection which were deleted
projects_deleted	uint32		number of projects owned by this collection which were deleted
project_ids_stopped	string	repeated	project ids owned by this collection whose broadcasts were stopped

DeleteDestinationRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the destination
project_id	string		project which owns the destination
destination_id	string		destination id
force	bool	optional	forcibly remove destination if enabled

DeleteDestinationResponse

Field	Type	Label	Description
broadcast_updated	bool		indicates whether the broadcast was updated as a function of this request

DeleteProjectRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id
force	bool	optional	forcibly end broadcast in progress

DeleteProjectResponse

Field	Type	Label	Description
broadcast_stopped	bool		was a broadcast stopped
layouts_deleted	uint32		the number of associated layouts deleted

DeleteSourceRequest

Field	Type	Label	Description
collection_id	string		collection which owns the live source
source_id	string		live source id
force	bool	optional	delete a live source even if it is in use in a broadcast

DeleteSourceResponse

Field	Type	Label	Description
project_ids_updated	string	repeated	project ids owned by this collection which were affected

Destination

streaming destination of project

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the destination
project_id	string		project which owns the destination
destination_id	string		destination id
metadata	google.protobuf.Value	optional	arbitrary metadata associated with this destination
enabled	bool	optional	is output stream enabled?
address	DestinationAddress		address of the destination
timeout	uint32	optional	timeout (ms) to wait before resetting a connection

DestinationAddress

destination address (select one)

Field	Type	Label	Description
rtmp_push	DestinationRtmpPushAddress		rtmp push addressing
agora	DestinationAgoraPushAddress		Agora addressing
s3_storage	S3StorageAddress		s3 storage addressing

DestinationAgoraPushAddress

Agora push addressing

Field	Type	Label	Description
app_id	string		Agora app id
channel_id	string		Agora channel id
user_id	string		Agora user id

DestinationCreateEvent

a destination was created

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the destination
project_id	string		project which owns the destination
destination_id	string		destination id
destination	Destination		the new destination

DestinationDeleteEvent

a destination was deleted

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the destination
project_id	string		project which owns the destination
destination_id	string		destination id

DestinationEvent

Field	Type	Label	Description
create	DestinationCreateEvent
update	DestinationUpdateEvent
delete	DestinationDeleteEvent
state	DestinationStateEvent

DestinationRtmpPushAddress

rtmp push destination address

Field	Type	Label	Description
key	string	optional	rtmp stream key
url	string		rtmp destination url

DestinationStateEvent

the state of a destination changed

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the destination
project_id	string		project which owns the destination
destination_id	string		destination id
connect	ConnectState		the state of the connection changed

DestinationUpdateEvent

a destination was updated

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the destination
project_id	string		project which owns the destination
destination_id	string		destination id
update_mask	string	repeated	changed fields
destination	Destination		the updated destination

Encoding

the parameters of the encoding

Field	Type	Label	Description
video	VideoEncoding	optional	the video parameters of the encoding
audio	AudioEncoding	optional	the audio parameters of the encoding

ExternalComposition

compose using an external renderer

Field	Type	Label	Description
url	string

GetCollectionRequest

Field	Type	Label	Description
collection_id	string		collection id
populate_projects	bool	optional	optionally populate projects
populate_sources	bool	optional	optionally populate sources

GetCollectionResponse

Field	Type	Label	Description
collection	Collection

GetCollectionsRequest

GetCollectionsResponse

Field	Type	Label	Description
collections	Collection	repeated	all collections owned by this user

GetDestinationRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the destination
project_id	string		project which owns the destination
destination_id	string		destination id

GetDestinationResponse

Field	Type	Label	Description
destination	Destination		the requested destination

GetJsonWebKeySetRequest

GetJsonWebKeySetResponse

Field	Type	Label	Description
keys	JsonWebKey	repeated	public keys used to sign access tokens

GetProjectBroadcastSnapshotRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id
format	ImageFormat	optional	snapshot binary format

GetProjectBroadcastSnapshotResponse

Field	Type	Label	Description
format	ImageFormat		the format of the returned snapshot
image	bytes		the binary snapshot

GetProjectBroadcastStatusRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id

GetProjectBroadcastStatusResponse

Field	Type	Label	Description
status	ProjectBroadcastStatus		the status of the project broadcast

GetProjectRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id
status	bool	optional	also query project broadcast status

GetProjectResponse

Field	Type	Label	Description
project	Project		the request project
status	ProjectBroadcastStatus	optional	the status of the project broadcast (if requested)

GetSourceRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the source
source_id	string		source id

GetSourceResponse

Field	Type	Label	Description
source	Source

GetSourcesRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the source

GetSourcesResponse

Field	Type	Label	Description
sources	Source	repeated

GetTestTokenRequest

GetTestTokenResponse

Field	Type	Label	Description
access_token	string		a dummy access key (with no grants)

GuestAccessToken

the type of access token (selec one)

Field	Type	Label	Description
direct	GuestAccessTokenDirect
exchange	GuestAccessTokenExchange

GuestAccessTokenDirect

create an immutable, single-use guest access token

Field	Type	Label	Description
display_name	string		display name of the guest (used to generate webrtc particpant name)
service_user_id	string	optional	service-specific user id (used for record auditing purposes)

GuestAccessTokenExchange

create a multi-use guest access token

Field	Type	Label	Description
max_duration	uint32	optional	the max duration this token is valid for redemption

GuestCode

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id
code	string		the short url code
url	string		the short url
auto_delete	google.protobuf.Timestamp		auto-delete after time

GuestCodeRedirectRequest

Field	Type	Label	Description
service_id	string		the id of the service
code	string		the short url code

GuestCodeRedirectResponse

HlsLifecycle

hls lifecycle management

Field	Type	Label	Description
vod	HlsLifecycleVod		lifecycle of vod
live	HlsLifecycleLive		lifecycle of live

HlsLifecycleLive

live hls lifecycle management

Field	Type	Label	Description
playlist_count	int32	optional	number of entries to advertise in playlist file
file_count	int32	optional	number of files to keep on disk

HlsLifecycleVod

vod hls lifecycle management

Field	Type	Label	Description
max_duration	int32	optional	max duration of the recording in ms (0 is indefinite)

HlsPackaging

hls packaging options

Field	Type	Label	Description
lifecycle	HlsLifecycle		lifecycle of hls segments
segment_duration	int32	optional	duration of segments in ms

HostedWebRtc

hosted webrtc configuration

Field	Type	Label	Description
enabled	bool	optional	enable webrtc services

JsonWebKey

Field	Type	Label	Description
alg	string
kty	string
use	string
kid	string
e	string
n	string

LatLong

optimal location of broadcast (to optimize routing and delay)

Field	Type	Label	Description
latitude	double
longitude	double

LiveEvent

Field	Type	Label	Description
collection	CollectionEvent
destination	DestinationEvent
project	ProjectEvent
source	SourceEvent
unspecified	google.protobuf.NullValue

ObjectStoragePackaging

packaging options for object storage

Field	Type	Label	Description
hls	HlsPackaging		hls format

PreviewAddress

addresses of source previews

Field	Type	Label	Description
webrtc	PreviewWebRtcAddress	optional	hls preview address optional PreviewHlsPullAddress hls = 1; webrtc preview address srt preview address optional SrtPullAddress srt = 3 [(common.v21.field_options).future = true ];

PreviewHlsPullAddress

request hls preview

Field	Type	Label	Description
enabled	bool	optional	request hls preview
url	string	optional	hls manifest url

PreviewWebRtcAddress

webrtc addressing parameters

Field	Type	Label	Description
enabled	bool	optional	request rtmp preview
display_name	string	optional	the name this source will use in the webrtc room
participant_id	string	optional	the id this source was assigned in the webrtc room

Project

project which owns a broadcast, sources, and destinations

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id
metadata	google.protobuf.Value	optional	arbitrary metadata associated with this project
rendering	Rendering		composition parameters
encoding	Encoding		encoding parameters
sources	Source	repeated	collection live sources added to this project
destinations	Destination	repeated	destinations associated with this project
composition	Composition		composition/layout source of the broadcast
max_duration	uint32	optional	maximum duration (ms) of project broadcasts
webrtc	WebRtc	optional	configuration for webrtc services (if requested)
triggers	ProjectTrigger	repeated	external triggers to start and stop this broadcast
location	LatLong	optional	optional optimal location to start broadcast
guest_codes	GuestCode	repeated	guest codes associated with this project

ProjectBroadcastStateEvent

the state of a project broadcast has changed

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id
broadcast_id	string		the id of the broadcast
phase	ProjectBroadcastPhase
error	ProjectBroadcastError

ProjectBroadcastStatus

broadcast status

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the broadcast
project_id	string		project which owns the broadcast
broadcast_id	string	optional
duration	uint32	optional	broadcast duration (ms)
start	google.protobuf.Timestamp	optional	broadcast start timestamp (ISO8601 UTC)
stop	google.protobuf.Timestamp	optional	broadcast stop timestamp (ISO8601 UTC)
phase	ProjectBroadcastPhase		broadcast phase
region	Region	optional	region broadcast is located
datacenter	string	optional	datacenter broadcast is located

ProjectCreateEvent

a project was created

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id
project	Project		the new project

ProjectDeleteEvent

a project was deleted

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id

ProjectEvent

Field	Type	Label	Description
create	ProjectCreateEvent
update	ProjectUpdateEvent
delete	ProjectDeleteEvent
state	ProjectBroadcastStateEvent

ProjectTrigger

the trigger type (select one)

Field	Type	Label	Description
source	SourceTrigger		start/stop project with source WebRtcTrigger webrtc = 2;

ProjectUpdateEvent

a project was updated

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id
update_mask	string	repeated	the fields that were updated
project	Project		the updated project

RefreshAccessTokenRequest

RefreshAccessTokenResponse

RemoveSourceFromProjectRequest

Field	Type	Label	Description
collection_id	string		the id of the parent Collection
project_id	string		the id of the Project
source_id	string		the id of the Source
force	bool	optional	delete a live source even if it is in use in a broadcast

RemoveSourceFromProjectResponse

Field	Type	Label	Description
project	Project		updated project
broadcast_updated	bool		indicates whether the broadcast was updated as a function of this request

Rendering

composition parameters

Field	Type	Label	Description
video	VideoRendering	optional	composition video parameters
audio	AudioRendering	optional	composition audio parameters
quality	RenderingQuality	optional	rendering quality
target_latency	uint32	optional	target end-to-end latency (in ms)
complexity	int32	optional	estimated composition complexity (where 0 is nominal complexity)

RtmpPullAddress

rtmp pull addressing

Field	Type	Label	Description
url	string		rtmp source url

S3StorageAddress

Field	Type	Label	Description
region	string		cloud region
bucket	string		cloud bucket
prefix	string	optional	cloud bucket prefix
access_key	string		cloud access key
secret_key	string		cloud secret key
token	string	optional	token based auth
token_duration	int32	optional	token duration in ms
acl	S3ACL	optional	access control list
endpoint	string	optional	endpoint for non aws s3 destinations
packaging	ObjectStoragePackaging		the format of the files to be written

SceneComposition

compose scenes using the browser-based compositor

Field	Type	Label	Description
renderer_url	string	optional	the url to pass to the studiosdk
selected_layout_id	string	optional	the active "scene" to render
debug	bool	optional

Source

collection live source

Field	Type	Label	Description
collection_id	string		collection which owns the source
source_id	string		collection source id
metadata	google.protobuf.Value	optional	arbitrary metadata associated with this collection source
preview	PreviewAddress	optional	preview addresses
address	SourceAddress		source address

SourceAddEvent

Field	Type	Label	Description
collection_id	string
source_id	string
project_id	string
source	Source

SourceAddress

live source address (select one)

Field	Type	Label	Description
rtmp_push	SourceRtmpPushAddress		rtmp push addressing
srt_push	SrtPushAddress		the srt address to publish to
rtmp_pull	RtmpPullAddress		the rtmp address to pull from the srt address to pull from SrtPullAddress srt_pull = 4;

SourceCreateEvent

Field	Type	Label	Description
collection_id	string		collection which owns the source
source_id	string		source id
source	Source

SourceDeleteEvent

Field	Type	Label	Description
collection_id	string
source_id	string

SourceEvent

Field	Type	Label	Description
create	SourceCreateEvent
update	SourceUpdateEvent
delete	SourceDeleteEvent
add	SourceAddEvent
remove	SourceDeleteEvent
state	SourceStateEvent

SourceRemoveEvent

Field	Type	Label	Description
collection_id	string
source_id	string
project_id	string

SourceRtmpPushAddress

rtmp push source address

Field	Type	Label	Description
enabled	bool	optional	enable source rtmp push address
key	string	optional	assigned rtmp stream key
url	string	optional	assigned rtmp destination url
base_url	string	optional	base_url without stream key

SourceStateEvent

the state of a destination changed

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the source
project_id	string		project id
source_id	string		destination id
connect	ConnectState		the state of the connection changed

SourceTrigger

triggers to indicate what actions to take on the project for a given Source

Field	Type	Label	Description
source_id	string		the id of the source
start	SourceTriggerAction	optional	source should trigger project(s) to start
stop	SourceTriggerAction	optional	source should trigger project(s) to stop

SourceUpdateEvent

Field	Type	Label	Description
collection_id	string
source_id	string
update_mask	string	repeated
source	Source

SrtPushAddress

srt push addressing

Field	Type	Label	Description
enabled	bool	optional	enable source srt push address
stream_id	string	optional	assigned srt streamid
url	string	optional	assigned srt destination url
base_url	string	optional	base_url without streamid

StartProjectBroadcastRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id
webrtc_start	bool	optional	also start webrtc room

StartProjectBroadcastResponse

Field	Type	Label	Description
broadcast_id	string		the id of the broadcast started

StartProjectWebRtcRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id

StartProjectWebRtcResponse

StopProjectBroadcastRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id
webrtc_stop	bool	optional	stop the associated webrtc room,

StopProjectBroadcastResponse

StopProjectWebRtcRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id

StopProjectWebRtcResponse

StudioSdkComposition

compose using the studiosdk renderer

Field	Type	Label	Description
renderer_url	string	optional	the page to render studio kit with. If set, this takes priority over version
version	string	optional	the version of the studio kit renderer to use. Ignored if renderer_url is set

UpdateCollectionRequest

Field	Type	Label	Description
collection_id	string		collection id
update_mask	google.protobuf.FieldMask		fields to update
metadata	google.protobuf.Value	optional	arbitrary metadata to associate with this collection

UpdateCollectionResponse

Field	Type	Label	Description
collection	Collection		the updated collection

UpdateDestinationRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the destination
project_id	string		project which owns the destination
destination_id	string		destination id
update_mask	google.protobuf.FieldMask		fields to update (default updates any non-null field)
metadata	google.protobuf.Value	optional	arbitrary metadata associated with this destination
address	DestinationAddress	optional	destination address (select one)
enabled	bool	optional	enable or disable this destination
timeout	uint32	optional	timeout (in milliseconds) to wait before resetting a connection

UpdateDestinationResponse

Field	Type	Label	Description
destination	Destination		updated destination
broadcast_updated	bool		indicates whether the broadcast was updated as a function of this request

UpdateProjectRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project id
update_mask	google.protobuf.FieldMask		fields to update
metadata	google.protobuf.Value	optional	arbitrary metadata to associate with this project
rendering	Rendering	optional	composition parameters
encoding	Encoding	optional	encoding parameters
composition	Composition	optional	composition/layout source of the broadcast
max_duration	uint32	optional	maximum duration of project broadcasts (ms)
webrtc	WebRtc	optional	configuration for webrtc services (if requested)
location	LatLong	optional	optimal broadcast location (for routing and delay)

UpdateProjectResponse

Field	Type	Label	Description
project	Project		updated project
broadcast_updated	bool		indicates whether the broadcast was updated as a function of this request

UpdateSourceInProjectRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project
project_id	string		project which will own the source
source_id	string		live source id
update_mask	google.protobuf.FieldMask		fields to update (default updates any non-null field)
trigger	SourceTrigger	optional	allow this source to trigger a project broadcast

UpdateSourceInProjectResponse

Field	Type	Label	Description
project	Project		updated project

UpdateSourceRequest

Field	Type	Label	Description
collection_id	string		collection which owns the project which owns the source
source_id	string		source id
update_mask	google.protobuf.FieldMask		fields to update (default updates any non-null field)
metadata	google.protobuf.Value	optional	arbitrary metadata to associate with this source
address	SourceAddress	optional	type of collection live source
preview	PreviewAddress	optional	enable real-time previews

UpdateSourceResponse

Field	Type	Label	Description
source	Source		updated source
broadcast_updated	bool		indicates whether the broadcast was updated as a function of this request

VideoCodecRateControl

video encoding CBR rate control params

Field	Type	Label	Description
mode	VideoCodecRateControlMode	optional
target_bitrate	uint32	optional	video encoding target bitrate (bits/s)
max_key_frame_interval	uint32	optional	maximum video encoding key frame interval (frames)

VideoEncoding

encoding video parameters

Field	Type	Label	Description
codec	VideoCodec	optional	video encoding codec
rate_control	VideoCodecRateControl	optional	video encoding rate control
profile	VideoCodecProfile	optional	video encoding codec profile

VideoRendering

composition video parameters

Field	Type	Label	Description
height	uint32	optional	canvas height (pixels)
width	uint32	optional	canvas width (pixels)
framerate	float	optional	canvas frame rate (frames/s)
color_space	VideoColorSpace	optional	rendering color space

WebRtc

webrtc service (select one)

Field	Type	Label	Description
hosted	HostedWebRtc		hosted webrtc configuration

WebRtcAccess

webrtc access parameters

Field	Type	Label	Description
access_token	string		access token for webrtc room
participant_id	string	optional	the id this user was assigned in the webrtc room

WebRtcTrigger

optional string service_user_id = 1;

Field	Type	Label	Description
stop	SourceTriggerAction	optional	webrtc stop should trigger project to stop

Enums

AudioChannelLayout

audio channel layout

Name	Number	Description
AUDIO_CHANNEL_LAYOUT_UNSPECIFIED	0
AUDIO_CHANNEL_LAYOUT_STEREO	1

AudioCodec

audio encoding codec

Name	Number	Description
AUDIO_CODEC_UNSPECIFIED	0
AUDIO_CODEC_AAC	1

ConnectState

the state of the connection

Name	Number	Description
CONNECT_STATE_UNSPECIFIED	0
CONNECT_STATE_CONNECTED	1
CONNECT_STATE_DISCONNECTED	2

EventSubType

Name	Number	Description
EVENT_SUB_TYPE_UNSPECIFIED	0
EVENT_SUB_TYPE_CREATE	1
EVENT_SUB_TYPE_UPDATE	2
EVENT_SUB_TYPE_DELETE	3
EVENT_SUB_TYPE_ADD	4
EVENT_SUB_TYPE_REMOVE	5
EVENT_SUB_TYPE_STATE	6

EventType

Name	Number	Description
EVENT_TYPE_UNSPECIFIED	0
EVENT_TYPE_COLLECTION	1
EVENT_TYPE_PROJECT	2
EVENT_TYPE_SOURCE	4
EVENT_TYPE_DESTINATION	5

ImageFormat

image binary format

Name	Number	Description
IMAGE_FORMAT_UNSPECIFIED	0
IMAGE_FORMAT_JPEG	1

ProjectBroadcastError

an error that occured during a broadcast

Name	Number	Description
PROJECT_BROADCAST_ERROR_UNSPECIFIED	0
PROJECT_BROADCAST_ERROR_INTERNAL	1
PROJECT_BROADCAST_ERROR_DURATION_EXCEEDED	2

ProjectBroadcastPhase

broadcast phase of project

Name	Number	Description
PROJECT_BROADCAST_PHASE_UNSPECIFIED	0
PROJECT_BROADCAST_PHASE_NOT_RUNNING	1
PROJECT_BROADCAST_PHASE_WAITING	2	broadcast is waiting to be scheduled
PROJECT_BROADCAST_PHASE_STARTING	3
PROJECT_BROADCAST_PHASE_RUNNING	4
PROJECT_BROADCAST_PHASE_STOPPING	5
PROJECT_BROADCAST_PHASE_STOPPED	6
PROJECT_BROADCAST_PHASE_ARCHIVED	7

Region

region which is hosting broadcast

Name	Number	Description
REGION_UNSPECIFIED	0
REGION_US_EAST_1	1	US East
REGION_US_EAST_2	2
REGION_US_WEST_1	3	US West
REGION_US_WEST_2	4
REGION_US_CENTRAL_1	5	US Central
REGION_AP_SOUTHEAST_1	10	Asia Pacific Southeast
REGION_CA_EAST_1	20	Canada East
REGION_EU_CENTRAL_1	30	Europe Central
REGION_EU_WEST_1	31	Europe West

RenderingQuality

rendering quality

Name	Number	Description
RENDERING_QUALITY_UNSPECIFIED	0
RENDERING_QUALITY_STANDARD	1
RENDERING_QUALITY_HIGH	2

Role

defined roles

Name	Number	Description
ROLE_UNSPECIFIED	0
ROLE_HOST	1
ROLE_COHOST	2
ROLE_CONTRIBUTOR	3
ROLE_GUEST	4
ROLE_VIEWER	5
ROLE_RENDERER	6
ROLE_PLATFORM	7
ROLE_IMPERSONATE	8

S3ACL

Name	Number	Description
S3ACL_UNSPECIFIED	0
S3ACL_PRIVATE	1
S3ACL_PUBLIC_READ	2
S3ACL_PUBLIC_READ_WRITE	3
S3ACL_AUTHENTICATED_READ	4
S3ACL_BUCKET_OWNER_READ	5
S3ACL_BUCKET_OWNER_FULL_CONTROL	6

SourceTriggerAction

boolean logic for trigger

Name	Number	Description
SOURCE_TRIGGER_ACTION_UNSPECIFIED	0
SOURCE_TRIGGER_ACTION_IGNORE	1
SOURCE_TRIGGER_ACTION_OR	3	SOURCE_TRIGGER_ACTION_AND = 2;

VideoCodec

video encoding codec

Name	Number	Description
VIDEO_CODEC_UNSPECIFIED	0
VIDEO_CODEC_H264	1

VideoCodecProfile

video encoding codec profile

Name	Number	Description
VIDEO_CODEC_PROFILE_UNSPECIFIED	0
VIDEO_CODEC_PROFILE_BASELINE	2
VIDEO_CODEC_PROFILE_MAIN	3
VIDEO_CODEC_PROFILE_HIGH	4

VideoCodecRateControlMode

video encoding rate control mode

Name	Number	Description
VIDEO_CODEC_RATE_CONTROL_MODE_UNSPECIFIED	0
VIDEO_CODEC_RATE_CONTROL_MODE_CBR	1	constant bit rate encoding

VideoColorSpace

rendering color space

Name	Number	Description
VIDEO_COLOR_SPACE_UNSPECIFIED	0
VIDEO_COLOR_SPACE_YUV420	1

Scalar Value Types (Reference)

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)