SpatialAudioCuePanning

public class SpatialAudioCuePanning
extension SpatialAudioCuePanning: NativeBase
extension SpatialAudioCuePanning: Hashable

Use the SpatialAudioCuePanning to notify each of the azimuths which compose a spatial audio trajectory along the audio cue.

  • Called once startAngularPanning() starts.

    Declaration

    Swift

    public typealias onSpatialAzimuthStarterHandler = (_ spatialTrajectoryData: SpatialTrajectoryData) -> Void

    Parameters

    spatialTrajectoryData

    The angular panning information of the current spatial trajectory.

  • This method will retrieve a stream of azimuth values to be passed onto the spatial audio renderer. An optional custom value for CustomPanningData.estimatedAudioCueDuration, CustomPanningData.initialAzimuthInDegrees, or its CustomPanningData.sweepAzimuthInDegrees can be here defined if the default data does not fully match the utilized Language or TTS engine or angle expectations. If startAngularPanning is called to spatialize the audio cue of a new maneuver before the full completion of a previous spatial audio trajectory, then EventTextDelegate will retrieve the azimuth values of the new maneuver.

    Declaration

    Swift

    public func startAngularPanning(nextCustomPanningData: CustomPanningData?, azimuthCallback: @escaping SpatialAudioCuePanning.onSpatialAzimuthStarterHandler)

    Parameters

    nextCustomPanningData

    Defines a new set of values related to spatial audio panning. When CustomPanningData is initialized as nil, the default set of values provided by HERE SDK will be used instead.
    azimuthCallback

    Callback that will signal the next azimuth required to complete a spatial audio trajectory once the angular panning has started. Azimuth angular values are retrieved individually until the full duration of the audio trajectory has been reached, or a new text message has started its angular panning.