Skip to content

Latest commit

 

History

History
125 lines (83 loc) · 6.27 KB

setup-guide.md

File metadata and controls

125 lines (83 loc) · 6.27 KB

QuickStart Guide

Getting started with HISPlayer Video Upload consists of implementing the following steps:

  1. Import HISPlayer SDK

  2. HISPlayer Video Upload Window

  3. Use the Stream URL

1. Import HISPlayerSDK

Video Upload feature is supported from HISPlayer SDK v4.0.0 and above. Make sure the HISPlayer SDK has been imported to your Unity project. Importing the package is the same as importing other normal packages in Unity. Select the package of HISPlayer SDK and import it.

Assets > Import Package > Custom Package > HISPlayerSDK unity package


2. HISPlayer Video Upload Window

At the upper side of the Unity screen, open the window Tools > HISPlayer > Upload Video

It will open the HISPlayer Video Upload configuration window.

NewView

HISPlayer Dashboard

This button will direct you to the main HISPlayer Dashboard webpage, or you can open https://dashboard.hisplayer.com/ with your browser. If you have not created an account yet, please create a new account on the HISPlayer Dashboard webpage by clicking Sign up. It is mandatory to create an account before using HISPlayer Video Upload feature.

Please register your name, email address and password. After signing up, you will need to confirm for the email address verification.

Email

The email address of your account that you have registered on HISPlayer Dashboard webpage. Please input the email address in the Email field. If invalid email address is inputted, it will throw an error.

Password

The password of your account that you have registered on HISPlayer Dashboard webpage. Please input the password in the Password field. If invalid password is inputted, it will throw an error.

Video Title

The title of the video that you will upload. You may input any text.

Upload Video

Click on the Upload Video button. It will open a window to select the video file that you wish to upload. MP4 and MOV formats are supported.

After selecting the video file, it will start uploading to the server. The video content will be transcoded and published automatically. The whole process will take some time, please wait until the Upload successful message appears. You may check the status message in the Status field of the HISPlayer Upload Video Window, or in the Unity console. The progress bar indicates the overall video uploading, transcoding and publishing progress percentage.

Get the Stream URLs

After Upload successful message has appeared, you will find the generated stream URLs in the Generated Stream URLs fields or in the Unity editor console.

NewView2

HLS and DASH formats are available. HLS supports Android, iOS, WebGL, Windows and MacOS. DASH supports Android, WebGL and Windows.

Click the Copy button to copy the URL to the clipboard.

3. Use the Stream URL

Before using the generated stream URL, make sure that HISPlayer SDK has been configured following your target platform. Please refer to the following documentation :

If you use HISPlayer Sample, please make sure the sample has been set-up properly :

  • Open Assets/HISPlayerSample/Scenes/HISPlayerSample.unity
  • Import TextMesh Pro Essential
  • Input the license key through the Inspector Window. HISPlayerController game object -> HISPlayerController component -> License Key

To change the default video URL using the new generated URL, go to HISPlayerController game object > Inspector Window > HISPlayerController (Script) > HISPlayer Attributes > MultiStreamProperties > Url > Replace the value with the new generated URL that you have copied previously.

After pasting the new generated URL, you may run your project through the Unity Editor or build your project targeting your desired platform (Android/iOS/WebGL/Windows/macOS).

For more details about using HISPlayer Sample, please refer to the following documentation HISPlayer Sample

HISPlayer Dashboard

You can verify the videos that have been uploaded on HISPlayer Dashboard. Please open https://dashboard.hisplayer.com/ with your browser, or you can click on HISPlayer Dashboard button on the HISPlayer Video Upload Window.

Input your email and password and click Sign in.

After sign in, you can check all the videos that have been uploaded. You can click on the video ID to check the generated HLS and DASH URLs and the video stream preview.

Video Guide

Please refer to the following video guide to use HISPlayer Video Upload: HISPlayer Video Upload from Unity Editor