@tivio/sdk-react 9.3.0 → 9.4.0

package/README.md

@@ -182,13 +182,13 @@ await user.createUserProfile({
 
 ```typescript
 user.setActiveUserProfileId(profileId: string): void
+```
 
 #### Delete user profile
 
 ```typescript
 user.deleteUserProfile(profileId: string): Promise<void>
 ```
-```
 
 ## Content
 
@@ -237,7 +237,7 @@ getFavorites(options?: GetUserProfileDataOptions): Promise<FavoriteWithData[]>
 ```
 **Example**
 ```typescript
-const favorites = await tivio.getFavorites()
+const favorites = await user.getFavorites()
 favorites.forEach(favorite => {
     console.log({
         name: favorite.name,
@@ -263,7 +263,7 @@ getWatchPositions(options?: GetUserProfileDataOptions): Promise<WatchPositionWit
 ```
 **Example**
 ```typescript
-const watchPositions = await tivio.getWatchPositions()
+const watchPositions = await user.getWatchPositions()
 watchPositions.forEach(watchPosition => {
     console.log({
         position: watchPosition.position, // watch position in milliseconds
@@ -284,7 +284,7 @@ getWatchHistory(options?: GetUserProfileDataOptions): Promise<WatchPositionWithD
 ```
 **Example**
 ```typescript
-const watchHistory = await tivio.getWatchHistory()
+const watchHistory = await user.getWatchHistory()
 watchHistory.forEach(watchPosition => {
     console.log({
         position: watchPosition.position, // watch position in milliseconds
@@ -302,7 +302,7 @@ watchHistory.forEach(watchPosition => {
 
 Simply call addToFavorites or removeFromFavorites on the Video or Tag.
 ```typescript
-const video = await tivio.getVideoById('videoId')   
+const video = await tivio.getVideoById('videoId')
 await video.addToFavorites()
 await video.removeFromFavorites()
 
@@ -585,7 +585,7 @@ The Tivio player supports different types of sources:
 **VOD_EXTERNAL** - External video-on-demand content from third-party URLs
 - Used for playing videos that are hosted outside of Tivio's infrastructure
 - Supports various streaming protocols (HLS, DASH, MP4)
-- Example usage:
+- Example usage (single url):
 ```typescript
 const externalSource = {
     type: SourceType.VOD_EXTERNAL,
@@ -597,6 +597,26 @@ const externalSource = {
     continuePositionMs: 10000, // Start at 10 seconds (optional)
 }
 ```
+- It is also possible to set multiple urls for external source type, e.g. when you want to use both DASH and HLS formats. Player then automatically will pick most suitable format to play depending on device capabilities.
+- Example usage (multiple urls):
+```typescript
+const externalSource = {
+    type: SourceType.VOD_EXTERNAL,
+    urls: ['https://example.com/video.m3u8', 'https://example.com/video.mpd'],
+    sourcePlayMode: SourcePlayMode.ON_DEMAND,
+}
+```
+
+**VOD_TIVIO** - Internal source type for playing content managed by Tivio
+- Used for playing videos and tv channels managed by Tivio infrastructure, e.g. everything that is uploaded through Tivio Admin application
+- For convenience, it is recommended to use shortcut format and pass the source as string in `${'videos' | 'tvChannels'}/{id}` format
+- Ids of corresponding videos and tv channel could be found in Tivio admin application
+- Example usage:
+```typescript
+const tivioVideoSource = 'videos/2BzH4xsTXW8vqYKJegXj'
+const tivioTvChannelSource = 'tvChannels/Ct4UcK6ozX3VfxaL5yP5'
+```
+- Otherwise, it is also possible to pass internal tivio source as an object with `type: SourceType.VOD_TIVIO` and additional parameters, similarly to external source type.
 
 #### Source Play Modes
 

package/README.md.bak

@@ -182,13 +182,13 @@ await user.createUserProfile({
 
 ```typescript
 user.setActiveUserProfileId(profileId: string): void
+```
 
 #### Delete user profile
 
 ```typescript
 user.deleteUserProfile(profileId: string): Promise<void>
 ```
-```
 
 ## Content
 
@@ -237,7 +237,7 @@ getFavorites(options?: GetUserProfileDataOptions): Promise<FavoriteWithData[]>
 ```
 **Example**
 ```typescript
-const favorites = await tivio.getFavorites()
+const favorites = await user.getFavorites()
 favorites.forEach(favorite => {
     console.log({
         name: favorite.name,
@@ -263,7 +263,7 @@ getWatchPositions(options?: GetUserProfileDataOptions): Promise<WatchPositionWit
 ```
 **Example**
 ```typescript
-const watchPositions = await tivio.getWatchPositions()
+const watchPositions = await user.getWatchPositions()
 watchPositions.forEach(watchPosition => {
     console.log({
         position: watchPosition.position, // watch position in milliseconds
@@ -284,7 +284,7 @@ getWatchHistory(options?: GetUserProfileDataOptions): Promise<WatchPositionWithD
 ```
 **Example**
 ```typescript
-const watchHistory = await tivio.getWatchHistory()
+const watchHistory = await user.getWatchHistory()
 watchHistory.forEach(watchPosition => {
     console.log({
         position: watchPosition.position, // watch position in milliseconds
@@ -302,7 +302,7 @@ watchHistory.forEach(watchPosition => {
 
 Simply call addToFavorites or removeFromFavorites on the Video or Tag.
 ```typescript
-const video = await tivio.getVideoById('videoId')   
+const video = await tivio.getVideoById('videoId')
 await video.addToFavorites()
 await video.removeFromFavorites()
 
@@ -585,7 +585,7 @@ The Tivio player supports different types of sources:
 **VOD_EXTERNAL** - External video-on-demand content from third-party URLs
 - Used for playing videos that are hosted outside of Tivio's infrastructure
 - Supports various streaming protocols (HLS, DASH, MP4)
-- Example usage:
+- Example usage (single url):
 ```typescript
 const externalSource = {
     type: SourceType.VOD_EXTERNAL,
@@ -597,6 +597,26 @@ const externalSource = {
     continuePositionMs: 10000, // Start at 10 seconds (optional)
 }
 ```
+- It is also possible to set multiple urls for external source type, e.g. when you want to use both DASH and HLS formats. Player then automatically will pick most suitable format to play depending on device capabilities.
+- Example usage (multiple urls):
+```typescript
+const externalSource = {
+    type: SourceType.VOD_EXTERNAL,
+    urls: ['https://example.com/video.m3u8', 'https://example.com/video.mpd'],
+    sourcePlayMode: SourcePlayMode.ON_DEMAND,
+}
+```
+
+**VOD_TIVIO** - Internal source type for playing content managed by Tivio
+- Used for playing videos and tv channels managed by Tivio infrastructure, e.g. everything that is uploaded through Tivio Admin application
+- For convenience, it is recommended to use shortcut format and pass the source as string in `${'videos' | 'tvChannels'}/{id}` format
+- Ids of corresponding videos and tv channel could be found in Tivio admin application
+- Example usage:
+```typescript
+const tivioVideoSource = 'videos/2BzH4xsTXW8vqYKJegXj'
+const tivioTvChannelSource = 'tvChannels/Ct4UcK6ozX3VfxaL5yP5'
+```
+- Otherwise, it is also possible to pass internal tivio source as an object with `type: SourceType.VOD_TIVIO` and additional parameters, similarly to external source type.
 
 #### Source Play Modes
 

package/dist/index.d.ts

@@ -2030,6 +2030,8 @@ export declare interface IndexedVideo extends IndexedObject {
     monetizationAccessIds: string[] | false;
 }
 
+export declare type InputSourceParams = SourceParams | VodExternalMultiSourceParams;
+
 export declare type IntegrationType = 'discord' | 'patreon';
 
 export declare interface InteractiveWidget<T extends InteractiveWidgetScene = InteractiveWidgetScene> {
@@ -7700,6 +7702,14 @@ export declare interface VirtualChannelSourceParams extends ChannelSourceParams
     drm?: Drm;
 }
 
+/**
+ * Interface representing the parameters for a VOD (Video On Demand) external multi-source configuration.
+ * Multi-source means an array of string URLs representing the external sources for the video content.
+ */
+export declare interface VodExternalMultiSourceParams extends Omit<VodExternalSourceParams, 'url'> {
+    urls: string[];
+}
+
 /**
  * @public
  */
@@ -8052,7 +8062,7 @@ export declare interface WebGridScreenProps {
  */
 export declare interface WebPlayerProps {
     id: string;
-    source?: SourceParams | VideoPath | ChannelPath | null;
+    source?: InputSourceParams | VideoPath | ChannelPath | null;
     onEnded?: () => any;
     /**
      * If true, the player will inherit the width and height of its parent element.