Skip to content

VideoPlaylistScheduler plugin

Daniel Neto edited this page Dec 23, 2024 · 17 revisions

Introduction

The VideoPlaylistScheduler plugin enables video broadcasting platforms to schedule and manage playlists as live shows. With a calendar-based interface, user group permissions, and time zone adaptation, it delivers a seamless and user-friendly experience for both administrators and regular users.

chrome-capture-2024-11-5 (1)


Feature Overview

Calendar Interface

  • Displays scheduled shows with a clear and intuitive layout.
  • Automatically adjusts to the viewer’s time zone.

Playlist Management

  • Each "show" is linked to a playlist, with individual videos treated as episodes.
  • The sequence of episodes is determined by the playlist order. Episodes are played in the exact order they appear in the playlist.
  • Episodes must fit within standard calendar time slots (30 minutes, 1 hour, 1.5 hours, 2 hours, etc.) for efficient scheduling.
  • Playlists with episodes of consistent length are recommended to ensure seamless looping and prevent overlap when repeating schedules.
  • Playback Modes:
    • Play One Episode Per Timeslot: Only a single episode from the playlist will be broadcast during the selected timeslot.
    • Play Sequentially to Fill Timeslot: Episodes from the playlist will play in sequence and loop until the timeslot ends.

image

Administrative Control

  • Administrators can schedule any playlist and manage all time slots.
  • Scheduling is done in 30-minute increments, and slots can be extended across multiple durations.

Regular User Permissions

  • Users in specific user groups can also schedule their playlists.
  • Regular users can only schedule the playlists they created.

Customization Options

  • HTML-enabled notes can be added to time slots for additional context.
  • Notes can include text styles, colors, or other customizations.

Sequential Playback and VOD

  • Episodes in a playlist are broadcasted one at a time in the order defined by the playlist.
  • Episodes are available as Video on Demand (VOD) after the live stream ends.

Important Notes About Playlist Scheduling

How Episodes Work

  • Playlists are not continuous streams unless configured: Each video (episode) in the playlist must be scheduled individually, unless the sequential playback mode is enabled.
    • For example, to play 10 episodes using the default mode, you must schedule 10 separate time slots, specifying when each episode will play.
    • With the Play Sequentially to Fill Timeslot mode, the playlist will play episodes in sequence and loop automatically until the timeslot ends.
  • Episodes are played in the exact order they are arranged in the playlist.
  • Playlists with consistent episode lengths (e.g., all 30 minutes or all 1 hour) work best:
    • This ensures that episodes align perfectly with the calendar's time slots.
    • When playlists loop, consistent durations prevent overlaps or gaps in scheduling.
  • If a playlist spans multiple sessions (e.g., across different days), the next unscheduled episode will start in the following time slot.

Calendar Time Slots

  • Scheduling is based on fixed calendar increments:
    • Available durations include 30 minutes, 1 hour, 1.5 hours, 2 hours, etc.
    • Episodes should match one of these durations for smooth scheduling.
    • If using sequential playback, the episodes will loop to fill the entire selected time slot.

Behavior of Live Streams

  • Single Show Rule:
    • If a live stream from the same show starts while another instance is already running, the current live stream will be dropped, and the new one will begin.
  • Parallel Live Streams:
    • To run multiple live streams simultaneously, they must belong to different shows.

Allowing Regular Users to Schedule Playlists

Create a User Group

  • Go to the user group settings and create a new group.

Enable Calendar Permissions

  • When creating or editing a user group, check the box labeled "Can use Calendar."

chrome-capture-2024-11-5 (2)

Assign Users to the Group

  • Add users to the group. Any user in this group can schedule playlists they created.

Access the Calendar

  • Regular users can access the calendar on the Organize Programs page. If they have the necessary permissions, they will see a button labeled "Schedule to play live."

chrome-capture-2024-11-5


Plugin Setup and Usage

Accessing the Plugin

  1. Open Plugins Manager:
    • Navigate to the plugins manager page.
  2. Open the Calendar:
    • Click the Calendar button in the VideoPlaylistScheduler plugin to access the scheduling interface.

image


Managing Video Status Post-Playback

Steps to Configure Video Status

  1. Open Plugin Parameters:

    • In the plugins manager, locate VideoPlaylistScheduler and click Edit Parameters.
  2. Set Status Options:

    • In the dropdown labeled "After the video play in a show change its status," select one of the following:
      • Do Not Change: The video’s status remains the same after playback.
      • Active: The video stays visible and accessible.
      • Unlisted: The video is hidden from public listings but accessible via direct link.
      • Unlisted but Searchable: Hidden from listings but still searchable.
      • FansOnly: Access limited to fans only.
      • Inactive: The video becomes unavailable after playback.
  3. Additional Options:

    • Play Calendar Live: Enable or disable live calendar playback.
    • Rebroadcast to Specific User ID: Enter a User ID to rebroadcast calendar events to a specific profile.

Creating a Show

Select Time Slots

  • In the calendar, choose one or more time slots for your show.

Configure Show Details

  • In the Playlist Show tab (right panel), search for your playlist, add a title, and select a color to categorize your show.
  • Select the Playback Mode:
    • Play One Episode Per Timeslot: A single episode will be played during the scheduled time slot.
    • Play Sequentially to Fill Timeslot: Episodes will play in sequence and loop until the time slot ends.

image

Save

  • Click Save to confirm the show and time slots.

Advanced Scheduling Techniques

Cross-Day Scheduling

  • Schedule shows to span multiple days. For example, a playlist scheduled for Monday at 3 PM and Wednesday at 5 PM will resume with the next unscheduled video in the sequence during each session.

Recurring Playlist Scheduling

  • Playlists set for different days and times will always play videos in the order defined by the playlist.

Dependencies

Rebroadcaster Plugin

Scheduler Plugin

Playlist Plugin

  • Manages playlists, essential for scheduling.

Live Plugin

  • Manages live streaming and ensures smooth broadcasts.

Conclusion

The VideoPlaylistScheduler plugin now supports advanced playback modes, allowing for more flexible scheduling:

  • Use the Play One Episode Per Timeslot mode for precise control.
  • Choose the Play Sequentially to Fill Timeslot mode to loop episodes and fill the scheduled time automatically.
Clone this wiki locally