# Changelog
All notable changes to the webrtc package will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [3.0.0-pre.1] - 2022-10-28

### Changed

- Add `AudioStreamTrack` constructor to set `AudioListener`.
- Change `WebRTC.Initialize` method to not throw exception when using OpenGL Core on Windows or macOS.
- Remove dependency *libc++.so.1* in Linux native plugin

### Fixed

- Fix `SetRemoteDescription` and `SetLocalDescription` method of `RTCPeerConnection` class to work correct when calling multiple at the same time.

## [2.4.0-exp.11] - 2022-09-28

### Changed

- Add **ValidationExceptions.json** to suppress warnings about the package validation.
- Stop to use flip shader so that removing `Resources` folder.
- Change parameter of `VideoStraamTrack.CaptureStreamTrack` method.

### Fixed

- Fix a bug when calling `GetStats` method multiple times at the same time.

## [2.4.0-exp.10] - 2022-08-09

### Fixed

- Fix crash when streaming video between different platforms.

## [2.4.0-exp.9] - 2022-08-01

### Fixed

- Fix the crash bug on Android devices like pixel4a when using Vulkan.

## [2.4.0-exp.8] - 2022-07-08

### Added

- Supported video encoding framerate control.
- Added the items in Profiler Window to show the CPU loads of video encoding/decoding thread.
- Add a new sample "ReplaceTrack" to demonstrate `RTCRtpSender.ReplaceTrack` method.

### Changed

- Changed arguments of `RTCPeerConnection.AddTransceiver` method to pass initial information of `RTCRtpTransceiver` when instanting it.

### Fixed 

- Fixed the crash because of the old version of NVIDIA graphics driver.
- Fixed the issue when garbage collected but the finalizer hasn't been called.
- Improved performance of video streaming when using Vulkan graphics API.

## [2.4.0-exp.7] - 2022-05-20

### Added

- Supported Unity 2021.3 LTS.
- Added clang-format file.
- Added CMakePresets.json file.
- Supported NVIDIA decoder for H264 codec.
- Added the codec selection option and video resolution option in the menu scene.

### Changed

- Moved CPU loads of the color conversion from the rendering thread to the worker thread.
- Upgraded NVIDIA Codec SDK 11.0.

### Fixed

- Removed unnecessary dependencies of the native plugin on Linux.

### Removed

- Removed an argument `EncoderType` for `WebRTC.Initialize` method.
- Removed `WebRTC.HardwareEncoderSupport` method.

## [2.4.0-exp.6] - 2022-02-24

### Fixed

- Fixed a crash bug where disposing `AudioStreamTrack` on a receiver side.

## [2.4.0-exp.5] - 2022-02-02

### Added

- Added the ability to execute pending native tasks manually from the main thread.
- Added support for sending basic native collections (`NativeArray<T>`, `NativeSlice<T>` and `NativeArray<T>.ReadOnly`) to `RTCDataChannel`.
- Added a property `RTCRtpTransceiver.Mid`.
- Added an argument `enableNativeLog` for `WebRTC.Initialize` method.
- Added "E2ELatency" scene in the sample.
- Added a constuctor without arguments in `AudioStreamTrack` class.

### Changed

- Upgraded libwebrtc [m92](https://groups.google.com/g/discuss-webrtc/c/hks5zneZJbo/m/Z-p4AfCrCQAJ).
- Changed compiler for native plugin on Windows (MSVC to Clang).
- Changed to use `OnAudioFilterRead` method in `MonoBehaviour` for audio rendering.
- Changed resizing texture dynamically on receiver side when using a property `scaleResolutionDownBy` in `RTCRtpEncodingParameters` class.
- Changed the exception type `ObjectDisposedException` when accessing instance after call Dispose method. 

### Fixed

- Fixed a crash bug where initializing video streaming on Unity Editor on Apple Silicon.
- Fixed a crash bug where configuring OpenGL Core as a graphics API on Unity Editor on windows.
- Fixed a bug that sending stereo audio produces mono clip on some peers.
- Fixed a crach bug where using Full HD resolution with HWA enabled on macOS(Intel).
- Fixed a crash bug where using Full HD resolution with HWA enabled on Windows.

### Removed

- Removed iOS Simulator (x86_64) support for make simple building process for iOS.

## [2.4.0-exp.4] - 2021-08-19

### Added

- mac M1 architecture native support
- Audio stream rendering support
- Add two scenes ("Audio" and "MultiAudioReceive") into the package sample
- Add `RTCAudioSourceStats` and `VideoSourceStats` class

### Changed

- Add the audio waveform graph to "MultiplePeerConnections" scene in the sample

### Fixed

- Fix the crash on Windows with Vulkan API on the "VideoReceive" sample
- Fix the crash when calling `WebRTC.Initialize` twice
- Fix the error in the build process on `Unity2021.2`

## [2.4.0-exp.3] - 2021-06-08

### Changed

- Add options of the incoming video in "VideoReceive" sample to test video capture modules on the device

### Fixed

- Fix the validation for the color space of the incoming video
- Fix the crash when accessing the property `RTCRtpSender.Track`

## [2.4.0-exp.2] - 2021-05-21

### Fixed

- Fix the color space of the RenderTexture for streaming when using Vulkan API
- Fix sample scenes
- Add a short version string to info.plist of ios framework

### Changed

- Add the validation of the streaming texture size on Android
- Add the validation of the  streaming when using NvCodec
- Use the software video decoder when disabling hardware acceleration

## [2.4.0-exp.1] - 2021-04-23

### Added

- Android ARM64 platform support
- Added a sample scene "Menu" which developers can go back and forth between sample scenes
- Added a sample scene "PerfectNegotiation"
- Added the software encoder on Linux support when using OpenGL Core graphics API
- Added the `RestartIce` method to the `RTCPeerConnection` class
- Added the `Streams` property to the `RTCRtpReceiver` class

### Changed

- Unity 2020.3 support
- Upgrade libwebrtc [m89](https://groups.google.com/g/discuss-webrtc/c/Zrsn2hi8FV0/m/KIbn0EZPBQAJ)
- Changed the argument type of the `RTCPeerConnection.CreateOffer` method and the `RTCPeerConnection.CreateAnswer` method

### Fixed

- Fixed crash for accessing properties of `RTCDataChannel` instance
- Fixed crash when using the invalid graphics format to stream video on macOS

## [2.3.3-preview] - 2021-02-26

### Added

- Added `OnConnectionStateChange` event to the `RTCPeerConnection` class

### Fixed

- Fixed a crash bug that occurs when accessing `MediaStreamTrack` properties after disposing of `RTCPeerConnection`

## [2.3.2-preview] - 2021-02-12

### Changed

- Changed `Audio.CaptureStream` method to allow setting of audio track label.

### Fixed

- Fixed memory leaks in native code.
- Fixed a crash bug when access an instance after disposed of it.
- Fixed `MediaStream.GetVideoStreamTrack` method and `MediaStream.GetVideoStreamTrack` method to return a correct value.
- Fixed `RTCRtpTransceiver.Receiver` property and `RTCRtpTransceiver.Sender` property to return a correct value.

## [2.3.1-preview] - 2021-01-07

### Fixed

- Fixed `RTCIceCandidate.candidate` property in order to return a correct SDP formatted string.

## [2.3.0-preview] - 2020-12-28

### Added

- Supported iOS platform
- Supported H.264 HW decoder (VideoToolbox) on macOS
- Added `GetCapabilities` method to the `RTCRtpSender` class and the `RTCRtpReceiver` class
- Added `SetCodecPreferences` method to the `RTCRtpTransceiver` class
- Added two samples ("ChangeCodecs", "TrickleIce")
- Added properties to the `RTCIceCandidate` class
- Added properties tp the `RTCDataChannelInit` class

### Changed

- Changed `RTCIceCandidate` type from `struct` to `class`
- Changed `RTCIceCandidateInit` type from `struct` to `class`
- Changed `RTCDataChannelInit` type from `struct` to `class`
- Changed argumments of the `RTCPeerConnection.AddIceCandidate` method
```csharp
// old
public void AddIceCandidate(ref RTCIceCandidate candidate);
// new
public bool AddIceCandidate(RTCIceCandidate candidate);
```

- Changed arguments of the `RTCPeerConnection.CreateDataChannel` method
```csharp
// old
public RTCDataChannel CreateDataChannel(string label, ref RTCDataChannelInit options);
// new
public RTCDataChannel CreateDataChannel(string label RTCDataChannelInit options = null);
```

## [2.2.1-preview] - 2020-11-13

### Added

- Added a "Bandwidth" sample

### Fixed

- Fixed the receiver of video streaming with Vulkan API
- Fixed a crash bug when the application ended using Vulkan API
- Fixed a crash bug of the standalone build using Vulkan API
- Fixed bugs that occur on Linux not installed NVIDIA driver
- Fixed a bug of the "VideoReceive" sample

## [2.2.0-preview] - 2020-10-26

### Added

- Software decoder support
- Hardware encoder (VideoToolbox) support on macOS
- Vulkan API support on Linux and Windows
- Linux IL2CPP support
- Add WebRTC samples ("MultiplePeerConnections", "MultiVideoReceive", "MungeSDP", "VideoReceive")

### Changed

- Upgrade libwebrtc m85
- Upgrade NVIDIA Codec SDK 9.1
- Changed `RTCPeerConnection` behaviour to throw exceptions when pass invalid arguments to `SetLocalDescription`, `SetRemoteDescription`

## [2.1.3-preview] - 2020-09-28

### Changed

- Add "minBitrate" parameter to `RTCRtpEncodingParameters` class.

## [2.1.2-preview] - 2020-09-14

### Changed

- Erase Japanese documentation due to migrating to internal translation system.

## [2.1.1-preview] - 2020-09-11

### Fixed

- Fixed an issue where the `RTCRtpSender.SetParameters` API did not work properly
- Removed ZWSP(zero-width-space) in C# code

## [2.1.0-preview] - 2020-08-24

### Added

- Added statistics window in Unity editor to allow checking the operation of WebRTC
- Added `RTCPeerConnection.GetStats` API which collect statistics of WebRTC
- Added `RTCRtpSender.SetParameters` and `RTCRtpSender.GetParameters` to adjustment streaming video quality
- Added `RTCDataChannel.ReadyState` which shows the state of the channel

### Fixed

- Fixed a issue which video stream remains with bad quality after a short network degradation

## [2.0.5-preview] - 2020-07-30

### Fixed

- Upgrade libwebrtc m84 to fix security issue (https://bugs.chromium.org/p/project-zero/issues/detail?id=2034)

## [2.0.4-preview] - 2020-07-10

### Fixed

- Fix a crash bug when dispose a video track

## [2.0.3-preview] - 2020-06-05

### Fixed

- Fix the memory leak when using DirectX12

## [2.0.2-preview] - 2020-05-14

### Fixed

- Fix the crash when using the incorrect parameter to as the argument of `RTCDataChannel` constructor
- Fix the crash when initializing the hardware encoder failed
- Fix the editor freeze bug when recompiling scripts
- Fixed documents

## [2.0.1-preview] - 2020-05-01

### Fixed

- Fixed versioning issue

## [2.0.0-preview] - 2020-04-30

### Added

- Multi camera support
- DirectX 12 API support
- Published VideoStreamTrack API
- Published AudioStreamTrack API

## [1.1.2-preview] - 2020-03-19

### Fixed

- Fix OpenGL color order

## [1.1.1-preview] - 2020-02-28

### Fixed

- Fix DLL import error

## [1.1.0-preview] - 2020-02-25

### Added

- IL2CPP support
- Linux OpenGL hardware encoder support
- Mac OS Metal software encoder support
- Windows DirectX11 software encoder support

### Changed

- Changed `Audio.Update` method to public

## [1.0.1-preview] - 2019-09-22

### Fixed

- Fixed documents

## [1.0.0-preview] - 2019-08-22

### Added

- Added tooltips

### Changed

- Renamed sample folders

## [0.2.0-preview] - 2019-07-30

### Changed

- Output logs when NVCodec failed to initialize

## [0.1.0-preview] - 2019-07-02

- Initial Release