@broadcastingplatforms/player 0.0.0-dev.0c8c26d → 0.0.0-dev.292ef76

package/README.md

@@ -54,6 +54,32 @@ import '@broadcastingplatforms/player';
 ></bp-player>
 ```
 
+### BPLive Stream
+
+Play a live stream from the BPLive platform:
+
+```html
+<bp-player
+  source='{"sources":[{"type":"bplive","streamId":123}]}'
+  config='{"bpLive":{"discoveryUrl":"https://api.example.com","authToken":"your-auth-token"}}'
+  muted
+  autoplay
+></bp-player>
+```
+
+### BPLive Clip
+
+Play a clip from the BPLive platform:
+
+```html
+<bp-player
+  source='{"sources":[{"type":"bplive","clipId":456,"preferredOrientation":"portrait"}]}'
+  config='{"bpLive":{"discoveryUrl":"https://api.example.com","authToken":"your-auth-token"}}'
+  muted
+  autoplay
+></bp-player>
+```
+
 ### With Default UI
 
 ```html
@@ -112,6 +138,43 @@ interface SourceDescription {
 }
 ```
 
+### PlayerSource Types
+
+```ts
+// Standard video/HLS source
+interface VideoSource {
+  type: 'video';
+  url: string;
+}
+
+// BPLive stream source
+interface BPLiveStreamSource {
+  type: 'bplive';
+  streamId: number;
+}
+
+// BPLive clip source
+interface BPLiveClipSource {
+  type: 'bplive';
+  clipId: number;
+  preferredOrientation?: 'landscape' | 'portrait'; // defaults to 'landscape'
+}
+```
+
+### ProviderConfig
+
+```ts
+interface ProviderConfig {
+  bpLive?: BPLiveConfig;
+  // ... other provider configs
+}
+
+interface BPLiveConfig {
+  discoveryUrl: string;  // Base URL of the BPLive API (required)
+  authToken?: string;    // Bearer token for authenticated API requests
+}
+```
+
 ### Analytics
 
 Connect analytics via the `ready` event using `@broadcastingplatforms/web-connectors`: