Allows you to initiate a new live stream on FastPix. Upon creating a stream, FastPix generates a unique stream key, which can be used with any broadcasting software (like OBS) to connect to FastPix's RTMP server. Users can configure the stream settings, including metadata (such as stream name and description), reconnect window (in case of disconnection), and privacy options (public or private).
How it works
When a user sends a POST request to this endpoint, FastPix returns the stream key, along with other stream details (RTMP URL). This key is essential for connecting the broadcasting software to FastPix’s servers and transmitting the live stream to viewers.
FastPix uses webhooks to tell your application about things that happen in the background, outside of the API regular request flow. For instance, once the live stream is created, we’ll shoot a POST message to the address you give us with the webhook event video.live_stream.created. Here’re other live stream event related webhooks you would want to look for.
Use case: A content creator wants to go live using a video production software like OBS or vMix. They initiate a stream using the API to set the title and other metadata, and receive the stream key, which they input into their broadcasting software.
Detailed example:
Imagine a gaming platform that allows users to live stream gameplay directly from their dashboard. The API creates a new stream, provides the necessary stream key, and sets it to "private" so that only specific viewers can access it.