Merge pull request #10 from HISPlayer/release/4.9.0

Release/4.9.0

Author: ivder

assets/ads-properties.jpg

@@ -106,6 +106,18 @@ The following public APIs are provided by **HISPlayerManager**
    * **public int width**: Width of the track.
    * **public int height**: Height of the track.
    * **public int framerate**: Framerate of the track in frames per second.
+ 
+* **public struct HISPlayerCaptionTrack**:
+   * **public string id**: Id of the caption
+   * **public string language**: Language of the caption
+ 
+* **public struct HisPlayerAudioTrack**:
+   * **public string id**: Id of the audio
+   * **public string caption**: Language of the audio
+ 
+* **public struct HISPlayerCaptionElement**: The information of the triggered event turns into caption’s format.
+   * **public int playerIndex**: The index of the player where the event is triggered.
+   * **public string language**: The next generated caption text.
 
 * **public enum LogLevel**: The current logging level to filter which log messages are output.
   * **ERROR** : Indicates critical errors that may prevent the application from functioning correctly.
@@ -221,6 +233,21 @@ This event occurs whenever the volume has been modified.
 Override this method to add custom logic when **HISPlayerEvent.HISPLAYER_EVENT_END_OF_PLAYLIST** is triggered.
 This event occurs whenever an internal playlist reaches the end of the list.
 
+#### protected virtual void EventTextRender(HISPlayerCaptionElement subtitlesInfo)
+Override this method to add custom logic when **HISPlayerEvent.HISPLAYER_EVENT_TEXT_RENDER** is triggered.
+This event occurs whenever a caption’s text has been generated.
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>caption</td>
+    <td>The next generated caption text.</td>
+  </tr>
+</table>
+
 #### protected virtual void EventAutoTransition(HISPlayerCaptionElement subtitlesInfo)
 Override this method to add custom logic when **HISPlayerEvent.HISPlayerEvent.HISPLAYER_EVENT_AUTO_TRANSITION** is triggered.
 This event occurs when the playback has changed to the next video in the playlist automatically.
@@ -405,9 +432,48 @@ Get the number of tracks of a certain stream. The **playerIndex** is associated
 #### protected void SelectTrack(int playerIndex, int trackIndex)
 Select a certain track of a certain stream to be used as the main track. This action will disable ABR, to enable it again you can use **EnableABR** API. The possible tracks can be obtained from the tracks returned from the method GetTracks. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
 
+#### public void EnableCaptions(int playerIndex, bool enabled)
+Enables the captions of the stream. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
+#### public HISPlayerCaptionTrack[] GetCaptionTrackList(int playerIndex)
+Provide information about all the captions of a certain stream. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
+#### public int GetCaptionsCount(int playerIndex)
+Obtain the number of captions of a certain stream. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
+#### public string GetCaptionID(int playerIndex, int ccTrackIndex)
+Obtain the ID of a certain caption of a certain player. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
+#### public string GetCaptionLanguage(int playerIndex, int ccTrackIndex)
+Obtain the language of a certain caption of a certain player. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
+#### public void SelectCaptionTrack(int playerIndex, int ccTrackIndex)
+Select a certain caption of a certain stream to be used. Before using this functions is recommended to use GetCaptionTrackList in order to know all the information about the captions. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
+#### public HisPlayerAudioTrack[] GetAudioTrackList(int playerIndex)
+Provide information about all the audio tracks of a certain stream. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
+#### public int GetAudioCount(int playerIndex)
+Obtain the number of audio of a certain stream. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
+#### public string GetAudioID(int playerIndex, int audioTrackIndex)
+Obtain the ID of a certain audio of a certain player. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
+#### protected string GetAudioLanguage(int playerIndex, int audioTrackIndex)
+Obtain the language of a certain audio of a certain player. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
+#### protected void SelectAudioTrack(int playerIndex, int audioTrackIndex)
+Select a certain audio-track of a certain stream to be used. Before using this functions is recommended to use GetAudioTrackList in order to know all the information about the audio-tracks. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
 #### protected void EnableABR(int playerIndex)
 Enables the ABR to change automatically between tracks. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
 
+#### protected void SetMaxBitrate(int playerIndex, int bitrate)
+Set a new maximum bitrate (in bits per second) of a specific track. This doesn’t disable ABR. The possible tracks can be obtained from the tracks returned from the method GetTracks. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
+#### protected void SetMinBitrate(int playerIndex, int bitrate)
+Set a new minimum bitrate (in bits per second) of a specific track. This doesn’t disable ABR. The possible tracks can be obtained from the tracks returned from the method GetTracks. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
+
 #### protected void DisableABR(int playerIndex)
 Disables the ABR to prevent the player from changing tracks regardless of bandwidth. The **playerIndex** is associated with the index of the element of **Multi Stream Properties**, e.g. the index 0 is the element 0 in the list.
 

assets/ads-properties.png

@@ -1,5 +1,19 @@
 # HISPlayer Unity WebGL SDK Release Notes
 
+### Version 4.9.0
+##### July 10, 2025
+- [**Added**] Added GetCaptionTrackList, GetCaptionCount, GetCaptionID, GetCaptionLanguage, EnableCaptions, SelectCaptionTrack APIs to get and select different caption tracks.
+- [**Added**] Added GetAudioTrackList, GetAudioCount, GetAudioID, GetAudioLanguage, SelectAudioTrack APIs to get and select different audio tracks.
+
+### Version 4.8.0
+##### July 7, 2025
+- [**Improvement**] Enhancement to InspectorGUI to dynamically show/hide certain options.
+- [**Added**] StartingBitrate moved from the general settings to the settings of each individual stream
+- [**Added**] Added TrackBitrateRange to select the bitrate range allowed in each stream
+- [**Added**] Added ResolutionMaxSize to select the resolution max size allowed in each stream
+- [**Added**] Added ResolutionMinSize to select the resolution min size allowed in each stream
+- [**Added**] Added SetMaxABRResolution and SetMinABRResolution to change the resolution settings allowed by the ABR in runtime
+
 ### Version 4.7.0
 ##### March 3, 2025
 - [**Added**] GetPlaybackSpeedRate and SetPlaybackSpeedRate APIs

hisplayer-api.md

@@ -119,7 +119,7 @@ You can also use the **Resources > Materials > HISPlayerDefaultMaterial.mat** we
 
 <p align="center">
 <img width=37% alt="image" src="https://github.com/HISPlayer/UnityAndroid-SDK/assets/47497948/eacab2a8-7cee-4218-add9-98672f250540">
-<img width=45% alt="image" src="https://github.com/HISPlayer/UnityWebGL-SDK/assets/47497948/ffe0ea80-d66b-4fac-beb0-01152bce200e">
+<img width=45% alt="image" src="https://github.com/user-attachments/assets/b27744d4-1f21-4237-ae1c-e241a022f8d4" />
 </p>
 
 ### <ins>Raw Image</ins>
@@ -128,7 +128,7 @@ This action will be related to Unity’s Canvas. If there is not a Canvas create
 For the creation, select **GameObject > UI > Raw Image**. Once it is created, attach it to the stream controller component
 
 <p align="center">
-<img width="600" alt="image" src="https://github.com/HISPlayer/UnityWebGL-SDK/assets/47497948/5dcc7a3f-7de5-4e87-a5e3-3e08587360b4">
+<img width="819" height="597" alt="image" src="https://github.com/user-attachments/assets/fda93ea3-72a7-4142-ad81-f93f0ce002a7" />
 </p>
 
 ### <ins>RenderTexture</ins>
@@ -139,7 +139,7 @@ For creating it from zero, select **Assets > Create > Render Texutre** and then
 Once all this process it’s done, associate the **RenderTexture** to the script component.
 
 <p align="center">
-<img src="https://github.com/HISPlayer/UnityiOS-SDK/assets/47497948/a0f26bc1-c7b1-432e-ad87-1a2d203d32c8">
+<img width="824" height="596" alt="image" src="https://github.com/user-attachments/assets/41154693-08aa-4d74-8a70-c5a587723d37" />
 </p>
 
 ## 2.3 Configure HISPlayer Properties
@@ -166,9 +166,13 @@ Use Multi Stream Properties to set all the configuration needed for multi stream
 * <span style="color:blue">**LoopPlayback**</span>: Loop the current playback. It's true by default.
 * <span style="color:blue">**AutoTransition**</span>: Change the playback to the next video in the playlist. This action won't have effect when loopPlayback is true. It's false by default.
 * <span style="color:blue">**AdsProperties**</span>: List of properties to configure advertisement insertions for each player in the scene. For more information, please refer to [**Playing Ads**](./playing-ads.md)
+* <span style="color:blue">**Starting Bitrate**</span>: The bitrate in bps the player will try to start playing. Setting it to 0 will make the player start with the lowest track.
+* <span style="color:blue">**Track Bitrate Range**</span>: Limits the tracks by bitrate range. X = Minimum bitrate, Y = Maximum bitrate (in bps).
+* <span style="color:blue">**Resolution Max Size**</span>: Limits the tracks by maximum resolution. X = Max width (px), Y = Max height (px).
+* <span style="color:blue">**Resolution Min Size**</span>: Limits the tracks by minimum resolution. X = Min width (px), Y = Min height (px).
 
 <p align="center">
-<img src="https://github.com/HISPlayer/UnityAndroid-SDK/assets/32887298/a6cddeab-c0d2-4607-b14f-1cbaf97db56c">
+<img width="776" height="748" alt="image" src="https://github.com/user-attachments/assets/429d95d0-bd09-4759-b9e0-7f217d3c7247" />
 </p>
 
 ## 2.4 Build and Run