DOCSEARCHbyAlgolia
Submit Docs

Caast Documentation

website·Indexed 34 days ago

https://docs.caast.tv/docs

Documentation for the Caast Library and API (v1), featuring guides on installing the JavaScript library, managing live streams and chat data, and implementing interactive display components like Shorts Story, Cards slider, and Floating widgets. Includes technical details on emitted events, data structures, purchase tracking via Caast Emitter, and integration tutorials for Flutter and Webview.

Tokens
21.9K
Snippets
112
Records
150
Agent score
50%

What's inside Caast

  1. Overview of Caast Shorts Story

    Caast Shorts Story is a user experience component that renders collections of content in a format similar to Instagram stories. It allows for the customization of displayed media and the ability to extract 'shorts' from existing content.

  2. Overview of the Caast Highlight component

    Caast Highlight is an interactive component that provides users with a preview of content teasers, live streams, or replays. It also supports a 'reminder' feature, allowing users to subscribe via SMS or calendars to receive notifications when a live event begins.

  3. Overview of the Caast Classic Launcher

    The Caast Classic Launcher is a display component typically used on product pages. It aggregates all incoming live streams or available replays related to a specific product into a single display, providing all relevant information in one place.

  4. Overview of Caast Shorts Card

    Caast Shorts Card is a UI experience designed to render collections of content in a vertical, short-form video style (similar to TikTok). It allows for the customization of displayed media and the ability to extract shorts from existing content.

  5. Overview of Caast Floating widget

    Caast floating is a display widget used to promote incoming live streams or replays on a website. It functions similarly to an advertisement, displaying a teaser or preview of content to generate leads from other pages of a site.

  6. Understand Caast's default GDPR configuration

    By default, Caast does not require GDPR consent from users because it does not retrieve personal data and does not store cookies on the user's website.

  7. Implement a media channel using Caast Landing

    Caast Landing is an integrated experience that allows developers to render a full media channel on a website with minimal code. It supports displaying all live streams or filtering them using specific hashtags. The layout, including the choice and order of content blocks, can be managed via the Caast administration interface.

  8. Enable Picture-in-Picture (PiP) for Caast Player

    The Picture-in-Picture (PiP) feature allows the Caast Player to be reduced to a corner of the user's screen, remaining active while the user continues to navigate other parts of the website.

  9. Manage products using a Product Feed in Caast

    Caast can automatically manage and regularly update your products using a product feed. This ensures that product information remains current based on the data provided in the feed.

  10. Retrieve details for a specific live stream

    Fetch detailed information about a live stream using its unique ID. The response includes stream attributes such as the m3u8 URL, RTMP URL, stream key, and associated products and seller information.
    GET /public/v1/lives/{id}

  11. Understand Caast Live stream states and properties

    Caast lives are entities used to manage live streaming content. They progress through three states: not_started, started, and finished. Once a live stream is finished, it produces a replay of the session. Every live stream provides an rtmpUrl and a streamKey used to send the video flux.

  12. Manage Caast cookie consent and user tracking

    By default, Caast does not drop cookies. If enabled in the administration interface, Caast uses a cookie named CaastFgpData to store a unique user identifier for advanced tracking. Disabling cookies prevents the ability to cross-reference data between live viewers and sell orders and makes establishing user uniqueness impossible.