AVChannelLayout

public struct AVChannelLayout : Equatable

Undocumented

  • Undocumented

    Declaration

    Swift

    public static let none: AVChannelLayout

  • Channel mask value used for AVCodecContext.request_channel_layout to indicate that the user requests the channel order of the decoder output to be the native codec channel order.

    Declaration

    Swift

    public static let CHL_NATIVE: AVChannelLayout

  • FC

    Declaration

    Swift

    public static let CHL_MONO: AVChannelLayout

  • FL+FR

    Declaration

    Swift

    public static let CHL_STEREO: AVChannelLayout

  • FL+FR+LFE

    Declaration

    Swift

    public static let CHL_2POINT1: AVChannelLayout

  • FL+FR+BC

    Declaration

    Swift

    public static let CHL_2_1: AVChannelLayout

  • FL+FR+FC

    Declaration

    Swift

    public static let CHL_SURROUND: AVChannelLayout

  • FL+FR+FC+LFE

    Declaration

    Swift

    public static let CHL_3POINT1: AVChannelLayout

  • FL+FR+FC+BC

    Declaration

    Swift

    public static let CHL_4POINT0: AVChannelLayout

  • FL+FR+FC+BC+LFE

    Declaration

    Swift

    public static let CHL_4POINT1: AVChannelLayout

  • FL+FR+SL+SR

    Declaration

    Swift

    public static let CHL_2_2: AVChannelLayout

  • FL+FR+BL+BR

    Declaration

    Swift

    public static let CHL_QUAD: AVChannelLayout

  • FL+FR+FC+SL+SR

    Declaration

    Swift

    public static let CHL_5POINT0: AVChannelLayout

  • FL+FR+FC+SL+SR+LFE

    Declaration

    Swift

    public static let CHL_5POINT1: AVChannelLayout

  • FL+FR+FC+BL+BR

    Declaration

    Swift

    public static let CHL_5POINT0_BACK: AVChannelLayout

  • FL+FR+FC+BL+BR+LFE

    Declaration

    Swift

    public static let CHL_5POINT1_BACK: AVChannelLayout

  • FL+FR+SL+SR+FLC+FRC

    Declaration

    Swift

    public static let CHL_6POINT0: AVChannelLayout

  • FL+FR+FLC+FRC+SL+SR

    Declaration

    Swift

    public static let CHL_6POINT0_FRONT: AVChannelLayout

  • FL+FR+FC+BL+BR+BC

    Declaration

    Swift

    public static let CHL_HEXAGONAL: AVChannelLayout

  • FL+FR+FC+SL+SR+LFE+BC

    Declaration

    Swift

    public static let CHL_6POINT1: AVChannelLayout

  • FL+FR+FC+BL+BR+LFE+BC

    Declaration

    Swift

    public static let CHL_6POINT1_BACK: AVChannelLayout

  • FL+FR+FLC+FRC+SL+SR+LFE

    Declaration

    Swift

    public static let CHL_6POINT1_FRONT: AVChannelLayout

  • FL+FR+FC+SL+SR+BL+BR

    Declaration

    Swift

    public static let CHL_7POINT0: AVChannelLayout

  • FL+FR+FC+SL+SR+FLC+FRC

    Declaration

    Swift

    public static let CHL_7POINT0_FRONT: AVChannelLayout

  • FL+FR+FC+SL+SR+LFE+BL+BR

    Declaration

    Swift

    public static let CHL_7POINT1: AVChannelLayout

  • FL+FR+FC+SL+SR+LFE+FLC+FRC

    Declaration

    Swift

    public static let CHL_7POINT1_WIDE: AVChannelLayout

  • FL+FR+FC+BL+BR+LFE+FLC+FRC

    Declaration

    Swift

    public static let CHL_7POINT1_WIDE_BACK: AVChannelLayout

  • FL+FR+FC+SL+SR+BL+BC+BR

    Declaration

    Swift

    public static let CHL_OCTAGONAL: AVChannelLayout

  • FL+FR+FC+SL+SR+BL+BC+BR+WL+WR+TBL+TBR+TBC+TFC+TFL+TFR

    Declaration

    Swift

    public static let CHL_HEXADECAGONAL: AVChannelLayout

  • DL+DR

    Declaration

    Swift

    public static let CHL_STEREO_DOWNMIX: AVChannelLayout

  • Undocumented

    Declaration

    Swift

    public let rawValue: UInt64

  • Undocumented

    Declaration

    Swift

    public init(rawValue: UInt64)

  • Return a channel layout id that matches name, or nil if no match is found.

    Declaration

    Swift

    public init?(name: String)

    Parameters

    name

    Name can be one or several of the following notations, separated by ‘+’ or ‘|’:

    • the name of an usual channel layout (mono, stereo, 4.0, quad, 5.0, 5.0(side), 5.1, 5.1(side), 7.1, 7.1(wide), downmix);
    • the name of a single channel (FL, FR, FC, LFE, BL, BR, FLC, FRC, BC, SL, SR, TC, TFL, TFC, TFR, TBL, TBC, TBR, DL, DR);
    • a number of channels, in decimal, followed by ‘c’, yielding the default channel layout for that number / of channels (@see av_get_default_channel_layout);
    • a channel layout mask, in hexadecimal starting with 0x (see the AV_CH_* macros).

    Example: stereo+FC = 2c+FC = 2c+1c = 0x7

  • The number of channels in the channel layout.

    Declaration

    Swift

    public var channelCount: Int { get }

  • Get the index of a channel in channel layout.

    Declaration

    Swift

    public func index(for channel: AVChannel) -> Int?

    Parameters

    channel

    A channel layout describing exactly one channel which must be present in channel layout.

    Return Value

    The index of channel in channel layout, nil on error.

  • Get the default channel layout for a given number of channels.

    Declaration

    Swift

    public static func `default`(for count: Int) -> AVChannelLayout

    Parameters

    count

    The number of channels.

    Return Value

    AVChannelLayout

Audio Channel Layout

  • Declaration

    Swift

    public var description: String { get }