Simulcast

Overview

Available Operations

delete_simulcast_of_stream - Delete a simulcast

delete_simulcast_of_stream

Deletes a simulcast using its unique simulcastId, which you received during the simulcast creation process. Deleting a simulcast stops the broadcast to the associated platform, while the parent stream continues if it’s live. This action can’t be undone, and you must create a new simulcast to resume streaming to the same platform.

Webhook event: video.live_stream.simulcast_target.deleted

Example

A broadcaster may need to stop simulcasting to one platform while keeping the stream active on others. For example, a tech company is simulcasting a product launch across multiple platforms. Midway through the event, they decide to stop the simulcast on Facebook due to performance issues but continue streaming on YouTube. They use this API to delete the Facebook simulcast target.

Example Usage

import os
import json

from fastpix_python import Fastpix, models

with Fastpix(
    security=models.Security(
        username="your-access-token",
        password="your-secret-key",
    ),
) as fastpix:

    res = fastpix.simulcast_stream.delete_simulcast_of_stream(
        stream_id="your-stream-id",
        simulcast_id="your-simulcast-id",
    )

    # Handle response
    print(json.dumps(res.model_dump(mode="json", by_alias=True, exclude_unset=True), indent=2))

Parameters

Parameter	Type	Required	Description	Example
`stream_id`	str	✔️	After creating a new live stream, FastPix assigns a unique identifier to the stream.	your-stream-id
`simulcast_id`	str	✔️	When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.	your-simulcast-id
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.DeleteSimulcastOfStreamResponse

Errors

Error Type	Status Code	Content Type
errors.FastpixDefaultError	4XX, 5XX	/

FilesExpand file tree

README.md

Latest commit

History