WCSStream

public class WCSStream

Publish and play streams

  • Add stream event callback.

    • event: kFPWCSStreamStatus event type
    • callback: StreamCallback callback block

    Declaration

    Swift

    public func on(_ event: kFPWCSStreamStatus, _ callback: @escaping StreamCallback)
  • Add stream status event callback.

    • callback: StreamEventCallback callback block

    Declaration

    Swift

    public func onStreamEvent(_ callback: @escaping StreamEventCallback)
  • Publish stream.

    Throws

    Declaration

    Swift

    public func publish() throws
  • Lock camera orientation

    Declaration

    Swift

    public func lockCameraOrientation()
  • Unlock camera orientation

    Declaration

    Swift

    public func unlockCameraOrientation()
  • Enable/disable loud speaker

    Throws

    Declaration

    Swift

    public func setLoudspeakerStatus(_ enable: Bool) throws
  • Undocumented

    Declaration

    Swift

    public func muteAudio()
  • Undocumented

    Declaration

    Swift

    public func unmuteAudio()
  • Undocumented

    Declaration

    Swift

    public func muteVideo()
  • Undocumented

    Declaration

    Swift

    public func unmuteVideo()
  • Undocumented

    Declaration

    Swift

    public func switchCamera()
  • Undocumented

    Declaration

    Swift

    public func isAudioMuted() -> Bool
  • Undocumented

    Declaration

    Swift

    public func isVideoMuted() -> Bool
  • Undocumented

    Declaration

    Swift

    public func getAudioState() -> FPWCSApi2MediaState
  • Undocumented

    Declaration

    Swift

    public func getVideoState() -> FPWCSApi2MediaState
  • Undocumented

    Declaration

    Swift

    public func getStats(_ callback: @escaping FPWCSApi2StatisticsCompletionHandler)
  • Play stream.

    Throws

    Declaration

    Swift

    public func play() throws
  • Stop stream.

    Throws

    Declaration

    Swift

    public func stop() throws
  • Get stream status.

    Declaration

    Swift

    public func getStatus() -> kFPWCSStreamStatus

    Return Value

    kFPWCSStreamStatus stream status

  • Get stream info.

    Declaration

    Swift

    public func getStatusInfo() -> kFPWCSStreamStatusInfo

    Return Value

    kFPWCSStreamStatusInfo stream info

  • Is stream published.

    Declaration

    Swift

    public func isPublished() -> Bool

    Return Value

    Bool true if stream published

  • Add stream available callback.

    @param callback StreamAvailableCallback callback block

    @return WCSStream stream

    Declaration

    Swift

    public func available(_ callback: @escaping StreamAvailableCallback) -> WCSStream
  • Undocumented

    Declaration

    Swift

    public func enableConnectionQualityCalculation(_ enable: Bool)
  • Undocumented

    Declaration

    Swift

    public func onConnectionQualityCallback(_ callback: @escaping StreamConnectionQualityCallback) -> WCSStream
  • Undocumented

    Declaration

    Swift

    public func sendData(_ data: Dictionary<String, Any>)