VideoDefinition

public class VideoDefinition : LinphoneObject

This object represents a video definition, eg. it’s width, it’s height and possibly it’s name. It is mostly used to configure the default video size sent by your camera during a video call with Core.setPreferredVideoDefinition() method.

  • Undocumented

    Declaration

    Swift

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

    Declaration

    Swift

    public var getCobject: OpaquePointer? { get }
  • Set the height of the video definition.

    Declaration

    Swift

    public var height: UInt { get set }

    Parameters

    height

    The height of the video definition Get the height of the video definition.

    Return Value

    The height of the video definition

  • Tells whether a VideoDefinition is undefined.

    Declaration

    Swift

    public var isUndefined: Bool { get }

    Return Value

    A boolean value telling whether the VideoDefinition is undefined.

  • Set the name of the video definition.

    Declaration

    Swift

    public var name: String { get set }

    Parameters

    name

    The name of the video definition
    Get the name of the video definition.

    Return Value

    The name of the video definition

  • Assign a user pointer to the video definition.

    Retrieve the user pointer associated with the video definition.

    Declaration

    Swift

    public var userData: UnsafeMutableRawPointer? { get set }

    Parameters

    userData

    The user pointer to associate with the video definition.

    Return Value

    The user pointer associated with the video definition.

  • Set the width of the video definition.

    Declaration

    Swift

    public var width: UInt { get set }

    Parameters

    width

    The width of the video definition Get the width of the video definition.

    Return Value

    The width of the video definition

  • Clone a video definition.

    Declaration

    Swift

    public func clone() -> VideoDefinition?

    Return Value

    The new clone of the video definition

  • Tells whether two VideoDefinition objects are equal (the widths and the heights are the same but can be switched).

    Declaration

    Swift

    public func equals(videoDefinition2: VideoDefinition) -> Bool

    Parameters

    videoDefinition2

    VideoDefinition object

    Return Value

    A boolean value telling whether the two VideoDefinition objects are equal.

  • Set the width and the height of the video definition.

    Declaration

    Swift

    public func setDefinition(width: UInt, height: UInt)

    Parameters

    width

    The width of the video definition

    height

    The height of the video definition

  • Tells whether two VideoDefinition objects are strictly equal (the widths are the same and the heights are the same).

    Declaration

    Swift

    public func strictEquals(videoDefinition2: VideoDefinition) -> Bool

    Parameters

    videoDefinition2

    VideoDefinition object

    Return Value

    A boolean value telling whether the two VideoDefinition objects are strictly equal.