# androidx.xr.compose.subspace.media

## Classes

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/PointSourceExoplayerAudioOutput` | Creates a `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SpatializedExoplayerAudioOutput` with `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PointSourceParams`. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SoundFieldExoplayerAudioOutput` | Creates a `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SpatializedExoplayerAudioOutput` from `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SoundFieldAttributes`. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SpatializedAudioOutput` | Signifies that a class is capable of configuring spatialized audio output. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SpatializedExoplayerAudioOutput` | Allows spatializing Exoplayer audio output. |

## Composables

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/rememberPointSourceExoplayerAudioOutput.composable` | Creates and remembers a `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/PointSourceExoplayerAudioOutput` with `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/PointSourceParams`. |

## Extension functions summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SpatializedAudioOutput` | `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SoundEffectPoolComponent.https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/package-summary#(androidx.xr.scenecore.SoundEffectPoolComponent).asSpatializedAudioOutput()()` Returns a `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SpatializedAudioOutput` that wraps this `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SoundEffectPoolComponent`. |
| `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/SubspaceModifier` | `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/layout/SubspaceModifier.https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/package-summary#(androidx.xr.compose.subspace.layout.SubspaceModifier).spatializedAudioOutput(androidx.xr.compose.subspace.media.SpatializedAudioOutput)( spatializedAudioOutput: https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SpatializedAudioOutput )` Adds spatialized audio output to this Composable. |

## Extension functions

### SoundEffectPoolComponent.asSpatializedAudioOutput

Artifact: [androidx.xr.compose:compose](https://developer.android.com/jetpack/androidx/releases/xr-compose) [View Source](https://cs.android.com/search?q=file:androidx/xr/compose/subspace/media/SpatializedAudioOutput.kt+function:asSpatializedAudioOutput) Added in [1.0.0-beta02](https://developer.android.com/jetpack/androidx/releases/xr-compose#1.0.0-beta02)

```
fun SoundEffectPoolComponent.asSpatializedAudioOutput(): SpatializedAudioOutput
```

Returns a `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SpatializedAudioOutput` that wraps this `https://developer.android.com/reference/kotlin/androidx/xr/scenecore/SoundEffectPoolComponent`. This allows the component's audio to be spatialized from the Composable it is attached to via `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/package-summary#(androidx.xr.compose.subspace.layout.SubspaceModifier).spatializedAudioOutput(androidx.xr.compose.subspace.media.SpatializedAudioOutput)`.

### SubspaceModifier.spatializedAudioOutput

Artifact: [androidx.xr.compose:compose](https://developer.android.com/jetpack/androidx/releases/xr-compose) [View Source](https://cs.android.com/search?q=file:androidx/xr/compose/subspace/media/SpatializedAudioOutput.kt+function:spatializedAudioOutput) Added in [1.0.0-beta02](https://developer.android.com/jetpack/androidx/releases/xr-compose#1.0.0-beta02)

```
fun SubspaceModifier.spatializedAudioOutput(
    spatializedAudioOutput: SpatializedAudioOutput
): SubspaceModifier
```

Adds spatialized audio output to this Composable. Use `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/PointSourceExoplayerAudioOutput`, `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SoundFieldExoplayerAudioOutput` or `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/package-summary#(androidx.xr.scenecore.SoundEffectPoolComponent).asSpatializedAudioOutput()` to create an object capable of spatializing audio.

```kotlin
import androidx.compose.runtime.DisposableEffect
import androidx.compose.runtime.remember
import androidx.compose.ui.platform.LocalContext
import androidx.compose.ui.unit.dp
import androidx.media3.common.MediaItem
import androidx.media3.exoplayer.ExoPlayer
import androidx.xr.compose.subspace.SpatialPanel
import androidx.xr.compose.subspace.layout.SubspaceModifier
import androidx.xr.compose.subspace.layout.height
import androidx.xr.compose.subspace.layout.movable
import androidx.xr.compose.subspace.layout.width
import androidx.xr.compose.subspace.media.rememberPointSourceExoplayerAudioOutput
import androidx.xr.compose.subspace.media.spatializedAudioOutput
import androidx.xr.scenecore.PointSourceParams

val context = LocalContext.current

// Create a PointSourceExoplayerAudioOutput.
val audioOutput = rememberPointSourceExoplayerAudioOutput(PointSourceParams())

// Create an ExoPlayer and set its AudioOutputProvider.
val exoPlayer = remember {
    ExoPlayer.Builder(context).setAudioOutputProvider(audioOutput.audioOutputProvider).build()
}

DisposableEffect(Unit) {
    exoPlayer.setMediaItem(MediaItem.fromUri("asset:///audio.mp3"))
    exoPlayer.prepare()
    exoPlayer.play()

    onDispose { exoPlayer.release() }
}

// Attach the SpatializedAudioOutput via SubspaceModifier.spatializedAudioOutput. The audio will
// be spatialized from the position of this SpatialPanel, and will follow the Panel as it moves.
SpatialPanel(
    modifier =
        SubspaceModifier.width(600.dp)
            .height(400.dp)
            .spatializedAudioOutput(audioOutput)
            .movable()
) {
    // Content of the panel
}
```

```kotlin
import androidx.compose.runtime.DisposableEffect
import androidx.compose.runtime.remember
import androidx.compose.ui.platform.LocalContext
import androidx.compose.ui.unit.dp
import androidx.media3.common.MediaItem
import androidx.media3.exoplayer.ExoPlayer
import androidx.xr.compose.platform.LocalSession
import androidx.xr.compose.subspace.SpatialPanel
import androidx.xr.compose.subspace.layout.SubspaceModifier
import androidx.xr.compose.subspace.layout.height
import androidx.xr.compose.subspace.layout.movable
import androidx.xr.compose.subspace.layout.width
import androidx.xr.compose.subspace.media.SoundFieldExoplayerAudioOutput
import androidx.xr.compose.subspace.media.spatializedAudioOutput
import androidx.xr.scenecore.SoundFieldAttributes
import androidx.xr.scenecore.SpatializerConstants

val context = LocalContext.current
val session = LocalSession.current ?: return

// Create a SoundFieldExoplayerAudioOutput.
val audioOutput = remember {
    SoundFieldExoplayerAudioOutput(
        session,
        SoundFieldAttributes(SpatializerConstants.AmbisonicsOrder.FIRST_ORDER),
    )
}

// Create an ExoPlayer and set its AudioOutputProvider.
val exoPlayer = remember {
    ExoPlayer.Builder(context).setAudioOutputProvider(audioOutput.audioOutputProvider).build()
}

DisposableEffect(Unit) {
    exoPlayer.setMediaItem(MediaItem.fromUri("asset:///ambient.mp3"))
    exoPlayer.prepare()
    exoPlayer.play()

    onDispose { exoPlayer.release() }
}

// Attach the SpatializedAudioOutput via SubspaceModifier.spatializedAudioOutput.
SpatialPanel(
    modifier =
        SubspaceModifier.width(600.dp)
            .height(400.dp)
            .spatializedAudioOutput(audioOutput)
            .movable()
) {
    // Content of the panel
}
```

```kotlin
import androidx.compose.material3.Button
import androidx.compose.material3.Text
import androidx.compose.runtime.remember
import androidx.compose.ui.platform.LocalContext
import androidx.compose.ui.unit.dp
import androidx.xr.compose.platform.LocalSession
import androidx.xr.compose.subspace.SpatialPanel
import androidx.xr.compose.subspace.layout.SubspaceModifier
import androidx.xr.compose.subspace.layout.height
import androidx.xr.compose.subspace.layout.movable
import androidx.xr.compose.subspace.layout.width
import androidx.xr.compose.subspace.media.asSpatializedAudioOutput
import androidx.xr.compose.subspace.media.spatializedAudioOutput
import androidx.xr.scenecore.PointSourceParams
import androidx.xr.scenecore.SoundEffectPool
import androidx.xr.scenecore.SoundEffectPoolComponent

val context = LocalContext.current
val session = LocalSession.current ?: return

// Create a SoundEffectPool.
val soundEffectPool = remember { SoundEffectPool.create(session, maxStreams = 10) }

// Remember a sound effect loaded via AssetFileDescriptor.
val soundEffect = remember {
    val assetFileDescriptor = context.assets.openFd("click.wav")
    soundEffectPool.load(assetFileDescriptor)
}

// Create a SoundEffectPoolComponent.
val soundEffectPoolComponent =
    remember(session, soundEffectPool) {
        SoundEffectPoolComponent.create(session, soundEffectPool, PointSourceParams())
    }

// Attach the SpatializedAudioOutput via SubspaceModifier.spatializedAudioOutput.
SpatialPanel(
    modifier =
        SubspaceModifier.width(600.dp)
            .height(400.dp)
            .spatializedAudioOutput(soundEffectPoolComponent.asSpatializedAudioOutput())
            .movable()
) {
    Button(
        onClick = {
            soundEffectPoolComponent.play(
                soundEffect,
                volume = 1f,
                priority = 0,
                isLooping = false,
            )
        }
    ) {
        Text("Play Sound Effect")
    }
}
```

| Parameters |
|---|---|
| `spatializedAudioOutput: https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SpatializedAudioOutput` | A `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SpatializedAudioOutput` to be added to this Composable. A `https://developer.android.com/reference/kotlin/androidx/xr/compose/subspace/media/SpatializedAudioOutput` should only be attached to one Composable at a time. If it is attached multiple times, its associated audio output will become head locked. |