Knowledge base
1000 FAQs, 500 tutorials and explanatory videos. Here, there are only solutions!
This guide explains how to password-protect videos imported to a VOD service.
Preamble
- Playing a video within a Player configured on the VOD service will require a password without which viewing will not be possible.
- It is not possible to specify multiple different passwords for the same video.
- Other access restrictions can be activated and concern access to the file: token | geoip
Protect a video with a password
Password protection can be configured in various ways.
1. Password at the import folder level
If the password is set once and for all at the destination folder level, all new media imports will automatically have this password for playback. However, it is still possible to modify the visibility of each video individually (read more below).
To configure this folder:
- Click here to access the management of your product on the Infomaniak Manager (need help?).
- Click directly on the name assigned to the product in question.
- Click on Media in the left sidebar.
- Click on Media Management in the left sidebar.
- Click on the icon to create a New folder:
- Name the folder.
- Click on the blue button to Create the folder.
- Click on Configuration:
- Select the encoding rules for the videos that will be imported, then proceed to the next step.
- Configure the folder options in step 2, then proceed to the next step.
- Set the password that will need to be entered to view a protected video:
- Click on the blue button once the desired restrictions have been configured.
- Upload new videos to this folder so that they are password-protected when played.
2. Password manually set on each video
To change the visibility of a video on a VOD service:
- Click here to access the management of your product on the Infomaniak Manager (need help?).
- Click directly on the name assigned to the product in question.
- Click on Media in the left sidebar.
- Click on Media Management in the left sidebar.
- Click on the relevant video:
- Click on Edit in the Status section.
- Click on Password to set a password.
- Click on the blue button to Change the status:
- The video becomes password-protected:
This guide concerns the authentication tokens or tokens, which are used to verify the identity of the application and to grant it specific permissions to interact securely with the features and data of the API.
Preamble
- Authentication tokens or tokens serve to verify the application's identity and grant it specific permissions to securely interact with the features and data of the Infomaniak API.
- There is no limit to the number of tokens you can create.
- The duration of an access token is "unlimited" by default, but it is possible to set a custom duration at its creation.
- Warning, if no call is made with the token for a year, it is automatically deactivated; it will then be necessary to generate a new one.
Manage Infomaniak API tokens
When creating an API token, you will be able to select the application and the scope accessible by the token (to match your current needs and project).
For this:
- Click here to access the management of your product on the Manager Infomaniak (need help?).
- Click the blue button Create a token.
- Select the appropriate product from the dropdown menu according to your current need and project.
- Choose a validity period.
- Click on the blue button Create a token.
- Enter the password to log in to the Manager as requested.
- Copy the token to a safe place - it will no longer be accessible after that.
Application example: token for the Newsletter API
This guide explains how to add subtitles to the media in your VOD space.
Preamble
- The subtitles for your videos are not destructive to the video itself; it is not altered, it is simply a *.srt file loaded by the Player.
- You can manage the automatic start of subtitles from the Player itself (tab #1).
Manage subtitles
To access the subtitle creation tool for your media:
- Click here to access the management of your product on the Infomaniak Manager (need help?).
- Click directly on the name assigned to the relevant product.
- Click on Media in the left sidebar.
- Click on Media Management in the left sidebar.
- Click on the media for which subtitles need to be generated.
- Click on Edit.
- Click on the Subtitles tab.
- Click the Add a language button to choose one of the 3 subtitle generation methods:
A. Manual subtitle creation
With this subtitling mode, you manually enter each text that needs to be displayed at the specified timecode:
B. Importing a subtitle file
You can import a file of type SubRip (*.srt
) or SubViewer (*.sbv
and *.sub
) to enhance your video with subtitles prepared in advance in a separate file:
The toggle switch button allows you to enable or disable the publication of subtitles on the Player; this notably allows you to check that the content is correct before publishing and sharing the video.
C. Generate subtitles automatically
You can create subtitles directly from the audio available on your media. The texts are generated thanks to artificial intelligence (AI, or computationally or equivalent).
Read and understand this other guide about the model used and the responsibilities of each. It is also recommended to manually check the generated content, especially proper nouns that are sometimes misspelled.
To generate subtitles, click the Generate button:
Translate the subtitles automatically
When subtitling exists, you can add an additional language in the same place, by having the text automatically translated (specify the current language), which will generate the appropriate subtitling in the desired language:
Automatically subtitle new videos
The Root folder or subfolders in your VOD space can have rules that are executed whenever new media is added to them. One of these rules can instruct to automatically generate subtitles using the method C above. To set up this rule:
- Click here to access the management of your product on the Infomaniak Manager (need help?).
- Click directly on the name assigned to the relevant product.
- Click on Media in the left sidebar.
- Click on Media Management in the left sidebar.
- Click on "Configure" on the Root folder or the folder of your choice page:
- Click on the Media Processing tab.
- Check that the treatments are not set to be inherited from the Parent folder (or configure the Parent folder directly) then save the changes if necessary (point 10 below).
- Enable text generation.
- Configure what should be generated (subtitles, video title, summary/description, as well as any translations depending on the visitor's language).
- Save the changes:
This guide explains how to modify the thumbnail (preview image, or thumbnail / poster) representing a video on a VOD service.
Foreword
- The use of animated gifs is not possible.
Change the video thumbnail
To access a media from the VOD space:
- Click here to access the management of your product on the Infomaniak Manager (need help?).
- Click directly on the name assigned to the relevant product.
- Click on Media in the left sidebar.
- Click on Media Management in the left sidebar.
- Click on the media you want to replace in the displayed table:
- Click on the Edit button:
Two options are available to replace the default image of the paused video:
- Select an image from within the video itself (click to scroll through the video and press the button to extract the image that you can then crop/resize):
- Upload an image from your hard drive (max. 10 MB) that you can then crop/resize.
Confirm by clicking the blue Save button:
This guide explains how to live stream a list of videos from the VOD service using the Streaming video product.
Preamble
- This feature allows you to use the **VOD service** to create a playlist of videos and then use the **Streaming video service** to broadcast it live, for example, as part of a music video channel, teleshopping, documentaries, etc.
- It is possible to insert advertisements between each video, manually or via the use of VAST tags.
- The playlist will loop indefinitely until the user stops it.
Stream a VOD playlist live
Prerequisites
- Have a VOD service (at least the free VOD space with the Streaming video service).
- Have a Streaming vidéo service within the same Organization and managed by the same account.
To create the playlist, import a few videos:
- Click here to access the management of your product on the Infomaniak Manager (need help?).
- Click directly on the name assigned to the relevant product.
- Click on the Select button (in the Quick Import section).
Once the videos are imported:
- Click on Media in the left sidebar.
- Click on Playlists / WebTV in the left sidebar.
- Click the button to add a new playlist.
- Name the playlist and determine if it should be automatic (linked to a folder) or manual.
- Select the folder or specific videos to use to create the playlist.
- Click on the Create a live stream button:
- Choose the stream from the **Video Streaming** service that will broadcast the playlist and set your preferences:
Some usage examples
Broadcasting a playlist can serve as a fallback solution as soon as a live stream is interrupted (voluntarily or involuntarily) and in this case take over the air. As soon as the live encoder pushes a stream, it takes back control of the playlist. This allows for the broadcasting of alternative content if there is a problem with the live stream or if the user only broadcasts true live content in the evening, for example, they can automate the broadcasting of content from playlists for the rest of the day.
It is also possible to schedule the broadcast of a playlist from the Streaming video scheduling tool. This way, you can choose to broadcast unique or different playlists in advance, or on a recurring basis. The live encoder will be automatically disconnected for the entire duration of the playlist broadcast; once the time slot is over, the encoder will reconnect and its content will be broadcast.
A VOD playlist can be created and then edited **manually** (by selecting the video that should complete the list) or be **dynamic** if automatically constituted by a set of videos located in a specific folder and fed over time. In both cases, **stop and then restart the live broadcast to take into account any new video added to the playlist** - note that this will no longer be mandatory during a future update of the tool.
This guide explains how to integrate a button overlay on the video in the Player VOD/AOD used to stream your video, allowing viewers to click and easily share the video link (or embed the video itself).
Preamble
- Automatic sharing is available for Facebook, X (formerly Twitter), LinkedIn, WhatsApp, but it is also possible to provide an HTML code for integrating the Player at the location desired by the visitor.
- Sharing can also be initiated within the media library itself.
Add a share link to the Player
To access the VOD space:
- Click here to access the management of your product on the Infomaniak Manager (need help?).
- Click directly on the name assigned to the relevant product.
- Click on Players in the left sidebar.
- Click on the relevant item in the table that appears.
- Click on the Share tab.
- Enable one or the other of the shares with the desired parameters, to see, on the Player, an icon representing the sharing possibility for the user:
- Do not forget to save your changes if necessary.
This guide explains how to obtain and configure notifications in case of an incident or consumption exceeding VOD/AOD.
Email alerts
To set up notifications:
- Click here to access the management of your product on the Manager Infomaniak (need help?).
- Click directly on the name assigned to the relevant product.
- Click on Settings in the left sidebar.
- Click on Notifications in the left sidebar.
- Add the Organization users to be notified by email.
- Set the monitoring schedules (days of the week / hours).
- Save the changes:
This guide details some background operations performed by the VOD / AOD service.
How SOAP requests and callbacks work
In the VOD (video on demand) and AOD (audio on demand) service, certain operations such as file downloads go through SOAP requests, a protocol that allows two systems to communicate with each other, often used to exchange data between servers.
When a file is requested via SOAP, there may be a delay before the server responds. This delay depends on several factors, such as the file size, server load, or connection quality. The download starts as soon as possible, but it is important to know that there is a queue: if several users make requests at the same time, each is processed in order, and each user has a limit on simultaneous downloads.
Callback: a notification at the end of the download
A callback is a system that allows to notify the client (for example, your application) once the download is complete. In other words, instead of waiting and monitoring the download, the system "calls" you or sends a response when everything is ready. This is useful to avoid blocking your application while the file is downloading.
However, there is also a maximum wait time, called timeoutIf this delay is reached before the download is complete, a response is still sent. This does not mean that the download has failed, but that the response was given before it was completed. In this case, the processing continues in the background.
Large files take more time
When the requested file is large (for example, several hundred megabytes or even several gigabytes), the download can take several minutes. This time depends greatly on the remote server: some are very fast, others less so. The system tries to manage this as best as possible, but it is important to keep in mind that the response time will not always be immediate.
Blocking and non-blocking calls
By default, some SOAP clients wait for the server to finish responding before continuing. This is known as a blocking call : your application is frozen until the response arrives. This can be problematic if the response takes time.
Fortunately, it is often possible to configure the SOAP client so that it does not block. This is then called a non-blocking callThis allows you to send multiple requests one after the other without having to wait for a response to each call. It is faster and more efficient, especially when you are processing multiple files in succession.
This guide explains how to protect videos imported into a VOD service with a unique key.
Preamble
- Note, token protection is only effective in the case of a standard integration via iframe and therefore through the use of the Player Infomaniak.
- Other access restrictions can be activated: password | geoip
Protect a video with a unique key
You have the possibility to protect all the media in a folder by creating a token. The latter will be unique for each of your visitors and must be passed as a parameter to your media to limit viewing. Only you will be able to generate the unique key, necessary for each user to watch the videos. This key therefore allows only the people previously verified by you to be authorized.
This allows you to control access to videos and only authorize certain people, while others are denied; useful in cases such as pay-per-view
or limited broadcasts. However, please note that you will need to develop the integration with your existing system.
If the hash is not valid, access to the video will return an error page "403 forbidden
".
Enable restriction on the import folder
Once the password is set once and for all at the destination folder level, all new media imports will automatically include this mode for playback. To configure this folder:
- Click here to access the management of your product on the Manager Infomaniak (need help?).
- Click directly on the name assigned to the relevant product.
- Click on Media in the left sidebar.
- Click on Media Management in the left sidebar.
- Click on the icon to create a New folder:
- Give a name to the folder.
- Click on the blue button to Create the folder.
- Click on Configuration:
- Select the encoding rules for the videos that will be imported, then proceed to the next step.
- Configure the folder options in this second step, then proceed to the next step.
- Enable the unique key restriction.
- Click on the blue button once the desired restrictions have been configured:
A video already encoded in another location of your VOD space will not be automatically protected even if it is moved within this folder. You will need to change its status manually (see below).
1. Create a VOD API token
To access the VOD API, you must first authenticate using an application token. This step only needs to be done once. The application token will be common for all folders you wish to protect. To create this application token, refer to this other guide and then the documentation https://developer.infomaniak.com/getting-started#authentication.
2. Create the playback token
This step must be done on your website/application and this token must be unique, so generated for each visitor.
It is therefore important that the page responsible for generating the token does not have a cache, in order to guarantee the uniqueness of the token.
POST https://api.vod2.infomaniak.com/api/pub/v1/channel/channel_id/share/share_id/token
channel_id
= 1227share_id
= corresponds to your video's identifier
Example: https://api.vod2.infomaniak.com/res/embed/1jhvl2uqa5rdf.html
The list of parameters is available in the documentation https://developer.infomaniak.com/docs/api/post/channel/share/token
3. Using the unique token on a media
The token retrieved in step 2 above will be passed as a parameter to the media; it will be unique and therefore different for each visitor:
<iframe frameborder="0" width="720" height="360" src="https://api.vod2.infomaniak.com/res/embed/1jhvl2uqa5rdf.html?token=st=1637143497~exp=1637143797~acl=/hls/1jhvl2uq4dnra/1jhvl2uq4dnmd/*~hmac=914aa838bdba141ec85db74266b54278572a1353a49e8851e4fd096dc6372127" allowfullscreen></iframe>
This guide explains how to embed video/audio files imported into a VOD/AOD service on web pages.
Introduction
- This VOD / AOD integration code is unique and corresponds to the parameters you are currently specifying on the page.
- It allows you to embed the same video with different display configurations according to your needs.
- Later, you will be able to modify the parameters of this integration by adjusting them from the integration history page on the Infomaniak Manager.
- You can also share a media in various ways.
Generate and copy the integration code
The integration code is located on your VOD interface; here is an example with a default Player:
- Click here to access the management of your product on the Infomaniak Manager (need help?).
- Click directly on the name assigned to the product in question.
- Click on Media in the left sidebar.
- Click on Media Management in the left sidebar.
- Click on the relevant media in the displayed table.
- Click on the blue Integrate button.
- Click on Create an integration:
- Customize the media integration (timestamp, loop playback, autoplay, …).
- Click the button to Generate the integration code:
- Copy the code to integrate it at your desired location:
The media will be inserted with the default Player, but you have the option to choose from your created Players the one that should be offered during integration.
Modify a previous integration
To customize the integration of your media that has already been done, and in order to keep the corresponding code without having to insert it again:
- Click here to access the management of your product on the Infomaniak Manager (need help?).
- Click directly on the name assigned to the product in question.
- Click on Media in the left sidebar.
- Click on Media Management in the left sidebar.
- Click on the media in question in the table that appears.
- Click on the blue Integrate button.
- Click on Edit integration:
- Click on the action menu â‹® to the right of the relevant item in the displayed table.
- Click on the desired element to obtain/modify the integration codes:
Paste the integration code…
On the web page of your choice, paste the code in the desired location.
... on Infomaniak Site Creator
- For Site Creator, you need to generate a “Fixed” integration code (not “Responsive”):
- Paste this code into Site Creator within a “Custom HTML Code” block.
Here is an example of copy-pasting from a media integration page: