Our Most Powerful SDKs
Right at Your Fingertips

Requires a membership in the Industries Circle

Resources

API Doc

Please sign in to download.

Sign In

Download Version

Label

• JavaScript version 4.4
• JavaScript version 4.3.2

DOWNLOAD

Photon Voice JavaScript SDK

(C) Exit Games GmbH 2025


Overview 
----------------------------------------------------------------------------------------------------
The Photon Javascript library provides a simple to use framework to access the Photon Server and the Photon Cloud.
Cross platform communication is possible, so Javascript clients can interact with DotNet or native clients.
The SDK supports 3 APIs.


Realtime (LoadBalancing) API
----------------------------------------------------------------------------------------------------
Allows to access Photon Cloud Realtime service: https://doc.photonengine.com/en-us/realtime/current/getting-started/realtime-intro

Voice API
----------------------------------------------------------------------------------------------------
To implement voice and video communication clients based on Photon Cloud Realtime: https://doc.photonengine.com/en-us/voice/current/getting-started/voice-intro
Supported browsers:
- Chrome Wndows, MacOS, Android
- Edge
- Opera

Chat API
----------------------------------------------------------------------------------------------------
Allows to access Photon Chat service: https://doc.photonengine.com/en-us/chat/current/getting-started/chat-intro


Documentation
----------------------------------------------------------------------------------------------------
The reference documentation is in this package. Follow links per API above for more documentation for Photon development.


Download
----------------------------------------------------------------------------------------------------
The latest version of Javascript SDK can be found at https://www.photonengine.com/sdks#realtime-sdkrealtimejavascript


Installation
----------------------------------------------------------------------------------------------------
- Extract the Photon Javascript SDK to a location of your choice

- Create an application in https://dashboard.photonengine.com/
  Use Voice application type for demo-voice and demo-voice-basics, Chat for demo-chat-api and Realtime for other demos.
- Set up you application info with a text editor in cloud-app-info.js file found in the demo root folder.
- Optionally for demo-particle and demo-pairs-mc samples, set FbAppId to your Facebook App id 
  in cloud-app-info.js for Facebook login. Place your HTML5 / JavaScript client code on one of 
  App Domains specified in your Facebook App settings. This required for proper Facebook Login 
  button work.
- Open default.html in browser.


Contact
----------------------------------------------------------------------------------------------------
To get in touch with other Photon developers and our engineers, Join our Discord Server https://dashboard.photonengine.com/account/profile
Keep yourself up to date following Exit Games on Twitter http://twitter.com/exitgames and our blog http://blog.photonengine.com


Package Contents
----------------------------------------------------------------------------------------------------
- license.txt         - the license terms
- readme.txt          - readme text
- release_history.txt - release history
- /doc                - the JavaScript API reference documentation
- /lib
  Typescript declaration files:
  -  photon.d.ts            - Photon Realtime
  -  photon-voice.d.ts      - Photon Voice
  Photon Realtime library:
  -  photon.js
  -  photon.min.js          - minimized
  Photon Realtime Emscripten library (binary protocol):
  -  photon-em.js
  -  photon-em.min.js       - minimized
  -  photon-em.wasm         - Wasm module loaded by the library
  Photon Realtime Emscripten library (binary protocol) JS version:
  -  photon-em-js.js
  -  photon-em-js.min.js    - minimized
  Photon Voice library (includes Photon Realtime Emscripten):
  -  photon-voice.js
  -  photon-voice.min.js    - minimized
  -  photon-voice.wasm      - Wasm module loaded by the library
  Photon Voice library (includes Photon Realtime Emscripten) JS version:
  -  photon-voice-js.js
  -  photon-voice-js.min.js - minimized
- /src    
  -  demo-loadbalancing     - basic Realtime (LoadBalancing) API demo application
  -  demo-particle          - demo showing more of the Realtime API's features
  -  demo-pairs-mc          - Turnbased Realtime application demo
  -  demo-voice             - Voice API demo application
  -  demo-voice-basics      - Voice API basics demo application
  -  demo-chat-api          - Chat API demo application

Requires a membership in the Industries Circle

Resources

API Doc

Please sign in to download.

Sign In

Download Version

Label

• Unity Video SDK version 2.63
• Unity Video SDK version 2.62

DOWNLOAD

# Photon Voice 2 Video Unity SDK

## Names
For now, we use Voice term in a meaning of Stream. PhotonVoice2 supports Audio Voices. This SDK adds Video Voices support.
We may change this naming to less confusing later.

## Video Processing
H264 codec is used for video streaming. Encoding and decoding are implemented with native platform API.

Video capture is implemented via native platform API on mobile platforms and UWP. On desktops, capture uses Unity WebCam API.

All platforms support video output to Unity textures (Platform.Create[PreviewManager,VideoRecorder,VideoPlayer]UnityTexture calls). This is the preferred output method. To use an object for video output, apply a material with "PhotonVoiceApi/VideoTexture3D" shader ("PhotonVoiceApi/VideoTextureExt3D" for Android) to it and assign PlatformView property of recorder or player as material's texture.

Mobile platforms and UWP also support video output via native platform API (Platform.CreateDefault[PreviewManager,VideoRecorder,VideoPlayer] methods).

## Supported platforms
- Windows
- MacOS
- iOS
- Android
- UWP (HL2)
- Unity WebGL (Chrome, Opera, Edge)

IL2CPP is the recommended scripting backend. Mono is not guaranteed to work.

There is no Unity integration for video streaming. Voice client should be used directly. It's possible to reuse existing audio Voice client in Unity or PUN app.

## Installation
- If updating existing project, remove PhotonVoiceLibs and PhotonVoiceApi folders in Assets\Photon\PhotonVoice\
- Import Photon Video SDK package
- Select *Window -> Photon Voice -> Enable Video* from the Editor menu (or manually add *PHOTON_VOICE_VIDEO_ENABLE* scripting define symbol for each platform).
- Open DemoVideo/SimpleVideo-Scene
- Set "App Id" field in SimpleAvSettings component on the Scripts GameObject
- Make sure that Camera and Microphone permissions enabled
## iOS
- Add VideoToolbox framework to UnityFramework target link dependencies (Build Phases)
## Android
- Minimum API level 28 (Android 9.0) is required
- if GameActivity is used (since Unity 6000), disable `kotlin-stdlib-*.jar` library in Assets\Photon\PhotonVoice\PhotonVoiceLibs\Android\libs to avoid `Duplicate class` build error
- Video encoder and decoder do not work with some Unity versions because of the bug: https://issuetracker.unity3d.com/issues/android-sbyte-type-is-considered-to-be-not-primitive-when-compiling-il2cpp-code
- OpenGL: if Unity Texture is used for video output or for encoder input:
   - Multithreading render is not supported
   - `Graphics > Default Render Pipeline` and `Quality > Levels > Rendering > Render Pipeline Asset` should be to `None`
## UWP
- If using MediaPlayerElement for video output, export XAML project.
- If using IMGUI (OnGUI driven) user interface, limit fps by setting QualitySettings.vSyncCount = 1 or Application.targetFrameRate = 60, otherwise UI methods calls make D3D video stall.
## Mac
- In case Unity can't load a bundle library and reports that it's damaged, try to:
  1. Open the MacOS terminal
  2. ```cd``` to ```Assets/Photon/PhotonVoice/PhotonVoiceLibs/OSX```
  3. Run ```xattr -d com.apple.quarantine *.bundle```

## Video Settings
- Bitrate. Currently Photon Cloud servers do not support rates higher than 400 kbit.
- Resolution. Please stick to the following video sizes which are tested with PhotonVoice Video:
   - 320x240
   - 640x480
   - 768x432
   - 848x480
   - 1024x576
   - 1280x720
   - 1920x1440
   
## Streaming Settings (VoiceCreateOptions and LocalVoice properties)
- Fragment. Set it to true to split large video frames into small packets sent independently by Photon transports. In unreliable mode, if some small packets are lost, the frame buffer is still passed to the decoder with 0s instead of lost data.
- Reliable. All packets are guaranteed to deliver. May be used in combination with Fragment.
- FEC. If > 0, after the specified number of frames, a forward error correction packet is sent. Do not use with Reliable. Mostly useful in Fragment mode because it reduces losses of large packet fragments.

## Multiple streams from the same camera
- Supported on Windows, Mac and WebGL.
- Create a 2nd video stream and specify the same camera name, but different bitrate.
- On Windows and Mac, also different resolutions are supported. High-res video stream must be created before low-res to avoid camera initialization with lower resolution.

# Photon Voice 2 Unity SDK

Photon Voice 2 adds high quality low latency voice chat to your Unity application.
Excellent sound quality due to the Opus codec and direct audio capture hardware support or software audio processing if capturing with Unity Microphone API.


## Platforms
Windows, UWP/Hololens, macOS, Linux, Android, iOS, WebGL and other platforms are supported.


## Features
- Can be used standalone or integrated with other Photon network solutions or third party audio modules for capture, playback, processing, lip sync, speech recognition, and more. The package includes PUN2, Fusion, FMOD and WebRTC Audio Processing integration modules. Demos of standalone Voice, PUN2 integration and Fusion integration are included.
- Inherits all Photon Realtime API features including matchmaking, interest groups, encryption, etc.
- Native modules are provided for all popular platforms to better support audio hardware.
- Audio playback via audio source preserves the location of audio stream in the 3D scene.
- Scales automatically in Photon Cloud's global hosting centers in US, Europe, Asia & Australia to any amount of concurrent users you need
- All for FREE including hosting in our Photon Cloud for up to 20 CCU.