Recorder

public class Recorder : LinphoneObject

Object used to record the audio or video of a call.

  • Undocumented

    Declaration

    Swift

    public static func getSwiftObject(cObject: OpaquePointer) -> Recorder
  • Undocumented

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }
  • Get linear volume when capturing audio.

    Declaration

    Swift

    public var captureVolume: Float { get }

    Return Value

    Linear volume.

  • Gets the duration of the recording.

    Declaration

    Swift

    public var duration: Int { get }

    Return Value

    the duration of the recording, in milliseconds.

  • Gets the file used for recording.

    Declaration

    Swift

    public var file: String { get }

    Return Value

    the file used for the recording if any.

  • Set the RecorderParams object.

    Declaration

    Swift

    public var params: RecorderParams? { get set }

    Parameters

    params

    The RecorderParams object to set.
    Retrieve the RecorderParams object.

    Return Value

    The RecorderParams object.

  • Gets the current state of the recorder.

    Declaration

    Swift

    public var state: RecorderState { get }

    Return Value

    the current RecorderState.

  • Set the user data.

    Declaration

    Swift

    public var userData: UnsafeMutableRawPointer? { get set }

    Parameters

    userData

    The user data to set.
    Retrieve the user data.

    Return Value

    the user data to retrieve.

  • Close the opened file.

    Declaration

    Swift

    public func close()
  • Create a content from the recording, for example to send it in a chat message.

    Warning

    Recorder must be in Closed state!

    Declaration

    Swift

    public func createContent() throws -> Content

    Return Value

    the Content matching the recording, or nil.

  • Open a file for recording.

    Declaration

    Swift

    public func open(file: String) throws

    Parameters

    file

    The path to the file to open.

  • Pause the recording.

    Declaration

    Swift

    public func pause() throws
  • Start the recording into the opened file.

    Declaration

    Swift

    public func start() throws