Skip to content

Commit 1755c52

Browse files
Merge pull request #43 from AristurtleDev/toc-fix
Resolve Table Of Content Issue
2 parents 2b008c0 + 53bed5a commit 1755c52

File tree

21 files changed

+314
-412
lines changed

21 files changed

+314
-412
lines changed

articles/getting_to_know/howto/audio/HowTo_ChangePitchAndVolume.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ But you can use your own if you wish.
125125

126126
Demonstrates how to load a wav file through a file stream.
127127

128-
* [Creating and Playing Sounds](../../whatis/WhatIs_Audio.md)
128+
* [Creating and Playing Sounds](../../whatis/audio/index.md)
129129

130130
Provides overviews about audio technology, and presents predefined scenarios to demonstrate how to use audio.
131131

articles/getting_to_know/howto/audio/HowTo_Microphone.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Also, you can use the **BufferReady** event handler of the [Microphone](xref:Mic
2929

3030
## See Also
3131

32-
* [Creating and Playing Sounds](../../whatis/WhatIs_Audio.md)
32+
* [Creating and Playing Sounds](../../whatis/audio/index.md)
3333

3434
Provides overviews about audio technology, and presents predefined scenarios to demonstrate how to use audio.
3535

articles/getting_to_know/howto/audio/HowTo_PlayASong.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The following demonstrates how to play a song from the media file in the content
6161

6262
## See Also
6363

64-
* [Media Overview](../../whatis/WhatIs_Audio.md)
64+
* [Media Overview](../../whatis/audio/index.md)
6565

6666
Provides a high-level overview about the capabilitiessuch as playing music and video and accessing picturesof the Media API in MonoGame.
6767

articles/getting_to_know/howto/audio/toc.yml

-18
This file was deleted.

articles/getting_to_know/howto/content_pipeline/toc.yml

-2
This file was deleted.

articles/getting_to_know/howto/graphics/toc.yml

-2
This file was deleted.

articles/getting_to_know/howto/input/toc.yml

-2
This file was deleted.

articles/getting_to_know/howto/toc.yml

-12
This file was deleted.

articles/getting_to_know/toc.yml

-30
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,68 @@
1-
---
2-
title: Sounds Overview
3-
description: An overview of how the MonoGame Framework provides audio playback through several core audio classes.
4-
requireMSLicense: true
5-
---
6-
7-
If your game is to use a few sound files, then the [SoundEffect](xref:Microsoft.Xna.Framework.Audio.SoundEffect), [SoundEffectInstance](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance), and [DynamicSoundEffectInstance](xref:Microsoft.Xna.Framework.Audio.DynamicSoundEffectInstance) classes will provide everything you need to play and stream audio during gameplay.
8-
9-
## Simple Audio Playback
10-
11-
The simplest way to play sounds for background music or sound effects is to use [SoundEffect](xref:Microsoft.Xna.Framework.Audio.SoundEffect) and [SoundEffectInstance](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance). Source audio files are added like any other game asset to the project. For example code, see [Playing a Sound](../howto/audio/HowTo_PlayASound.md), [Looping a Sound](../howto/audio/HowTo_LoopASound.md), and [Adjusting Pitch and Volume](../howto/audio/HowTo_ChangePitchAndVolume.md). For background music, see [Playing a Song](../howto/audio/HowTo_PlayASong.md).
12-
13-
## Accessing the Audio Buffer
14-
15-
Developers can use [DynamicSoundEffectInstance](xref:Microsoft.Xna.Framework.Audio.DynamicSoundEffectInstance) for direct access to an audio buffer. By accessing the audio buffer, developers can manipulate sound, break up large sound files into smaller data chunks, and stream sound. For example code, see [Streaming Data from a WAV File](../howto/audio/HowTo_StreamDataFromWav.md).
16-
17-
## 3D Audio
18-
19-
The [SoundEffect](xref:Microsoft.Xna.Framework.Audio.SoundEffect) class provides the ability to place audio in a 3D space. By creating [AudioEmitter](xref:Microsoft.Xna.Framework.Audio.AudioEmitter) and [AudioListener](xref:Microsoft.Xna.Framework.Audio.AudioListener) objects, the API can position a sound in 3D, and can change the 3D position of a sound during playback. Once you create and initialize [AudioEmitter](xref:Microsoft.Xna.Framework.Audio.AudioEmitter) and [AudioListener](xref:Microsoft.Xna.Framework.Audio.AudioListener), call [SoundEffectInstance.Apply3D](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance).
20-
21-
## Audio Constraints
22-
23-
When working with multiple platforms using MonoGame, there are a few constraints around audio that you will need to keep in mind and cater for, namely:
24-
25-
* Mobile platforms have a maximum of 32 sounds playing simultaneously.
26-
* Desktop platforms have a maximum of 256 sounds playing simultaneously.
27-
* Consoles and other platforms have their own constraints, please look at the console sdk documentation for more information,
28-
29-
> [!IMPORTANT]
30-
> An [InstancePlayLimitException](xref:Microsoft.Xna.Framework.Audio.InstancePlayLimitException) exception is thrown if this limit is exceeded.
31-
32-
## Audio Buffer Format
33-
34-
The `byte[]` buffer format used as a parameter for the [SoundEffect](xref:Microsoft.Xna.Framework.Audio.SoundEffect) constructor, [Microphone.GetData](xref:Microsoft.Xna.Framework.Audio.Microphone) method, and [DynamicSoundEffectInstance.SubmitBuffer](xref:Microsoft.Xna.Framework.Audio.DynamicSoundEffectInstance) method is PCM wave data. Additionally, the PCM format is interleaved and in little-endian.
35-
36-
The audio format has the following constraints:
37-
38-
* The audio channels can be mono (1) or stereo (2).
39-
* The PCM wave file must have 16-bits per sample.
40-
* The sample rate must be between 8,000 Hz and 48,000 Hz.
41-
* The interleaving for stereo data is left channel to right channel.
42-
43-
## Songs as Background Music
44-
45-
Access to the media library, combined with the ability to use playlists, allows games to create interesting background scores that can change with gameplay. Songs can be played directly from the media library, or can be imported by using the Content Pipeline. For more information, see [Playing a Song](../howto/audio/HowTo_PlayASong.md).
46-
47-
## Concepts
48-
49-
> [!IMPORTANT]
50-
> How to articles to follow.
51-
52-
## Reference
53-
54-
* [SoundEffect Class](xref:Microsoft.Xna.Framework.Audio.SoundEffect)
55-
56-
Provides a loaded sound resource.
57-
58-
* [SoundEffectInstance Class](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance)
59-
60-
Provides a single playing, paused, or stopped instance of a [SoundEffect](xref:Microsoft.Xna.Framework.Audio.SoundEffect) sound.
61-
62-
* [DynamicSoundEffectInstance Class](xref:Microsoft.Xna.Framework.Audio.DynamicSoundEffectInstance)
63-
64-
Provides properties, methods, and events for play back of the audio buffer.
65-
66-
* [Song Class](xref:Microsoft.Xna.Framework.Media.Song)
67-
68-
Provides access to a song in the song library.
1+
---
2+
title: Sounds Overview
3+
description: An overview of how the MonoGame Framework provides audio playback through several core audio classes.
4+
requireMSLicense: true
5+
---
6+
7+
If your game is to use a few sound files, then the [SoundEffect](xref:Microsoft.Xna.Framework.Audio.SoundEffect), [SoundEffectInstance](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance), and [DynamicSoundEffectInstance](xref:Microsoft.Xna.Framework.Audio.DynamicSoundEffectInstance) classes will provide everything you need to play and stream audio during gameplay.
8+
9+
## Simple Audio Playback
10+
11+
The simplest way to play sounds for background music or sound effects is to use [SoundEffect](xref:Microsoft.Xna.Framework.Audio.SoundEffect) and [SoundEffectInstance](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance). Source audio files are added like any other game asset to the project. For example code, see [Playing a Sound](../../howto/audio/HowTo_PlayASound.md), [Looping a Sound](../../howto/audio/HowTo_LoopASound.md), and [Adjusting Pitch and Volume](../../howto/audio/HowTo_ChangePitchAndVolume.md). For background music, see [Playing a Song](../../howto/audio/HowTo_PlayASong.md).
12+
13+
## Accessing the Audio Buffer
14+
15+
Developers can use [DynamicSoundEffectInstance](xref:Microsoft.Xna.Framework.Audio.DynamicSoundEffectInstance) for direct access to an audio buffer. By accessing the audio buffer, developers can manipulate sound, break up large sound files into smaller data chunks, and stream sound. For example code, see [Streaming Data from a WAV File](../../howto/audio/HowTo_StreamDataFromWav.md).
16+
17+
## 3D Audio
18+
19+
The [SoundEffect](xref:Microsoft.Xna.Framework.Audio.SoundEffect) class provides the ability to place audio in a 3D space. By creating [AudioEmitter](xref:Microsoft.Xna.Framework.Audio.AudioEmitter) and [AudioListener](xref:Microsoft.Xna.Framework.Audio.AudioListener) objects, the API can position a sound in 3D, and can change the 3D position of a sound during playback. Once you create and initialize [AudioEmitter](xref:Microsoft.Xna.Framework.Audio.AudioEmitter) and [AudioListener](xref:Microsoft.Xna.Framework.Audio.AudioListener), call [SoundEffectInstance.Apply3D](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance).
20+
21+
## Audio Constraints
22+
23+
When working with multiple platforms using MonoGame, there are a few constraints around audio that you will need to keep in mind and cater for, namely:
24+
25+
* Mobile platforms have a maximum of 32 sounds playing simultaneously.
26+
* Desktop platforms have a maximum of 256 sounds playing simultaneously.
27+
* Consoles and other platforms have their own constraints, please look at the console sdk documentation for more information,
28+
29+
> [!IMPORTANT]
30+
> An [InstancePlayLimitException](xref:Microsoft.Xna.Framework.Audio.InstancePlayLimitException) exception is thrown if this limit is exceeded.
31+
32+
## Audio Buffer Format
33+
34+
The `byte[]` buffer format used as a parameter for the [SoundEffect](xref:Microsoft.Xna.Framework.Audio.SoundEffect) constructor, [Microphone.GetData](xref:Microsoft.Xna.Framework.Audio.Microphone) method, and [DynamicSoundEffectInstance.SubmitBuffer](xref:Microsoft.Xna.Framework.Audio.DynamicSoundEffectInstance) method is PCM wave data. Additionally, the PCM format is interleaved and in little-endian.
35+
36+
The audio format has the following constraints:
37+
38+
* The audio channels can be mono (1) or stereo (2).
39+
* The PCM wave file must have 16-bits per sample.
40+
* The sample rate must be between 8,000 Hz and 48,000 Hz.
41+
* The interleaving for stereo data is left channel to right channel.
42+
43+
## Songs as Background Music
44+
45+
Access to the media library, combined with the ability to use playlists, allows games to create interesting background scores that can change with gameplay. Songs can be played directly from the media library, or can be imported by using the Content Pipeline. For more information, see [Playing a Song](../../howto/audio/HowTo_PlayASong.md).
46+
47+
## Concepts
48+
49+
> [!IMPORTANT]
50+
> How to articles to follow.
51+
52+
## Reference
53+
54+
* [SoundEffect Class](xref:Microsoft.Xna.Framework.Audio.SoundEffect)
55+
56+
Provides a loaded sound resource.
57+
58+
* [SoundEffectInstance Class](xref:Microsoft.Xna.Framework.Audio.SoundEffectInstance)
59+
60+
Provides a single playing, paused, or stopped instance of a [SoundEffect](xref:Microsoft.Xna.Framework.Audio.SoundEffect) sound.
61+
62+
* [DynamicSoundEffectInstance Class](xref:Microsoft.Xna.Framework.Audio.DynamicSoundEffectInstance)
63+
64+
Provides properties, methods, and events for play back of the audio buffer.
65+
66+
* [Song Class](xref:Microsoft.Xna.Framework.Media.Song)
67+
68+
Provides access to a song in the song library.

articles/getting_to_know/whatis/content_pipeline/CP_Architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The format of data in the .XNB file is tightly coupled to the MonoGame Framework
4242

4343
### Runtime Components
4444

45-
Runtime components of the Content Pipeline support loading and using the transformed game asset by your MonoGame game. These components use the [MonoGame library](../WhatIs_MonoGame_Class_Library.md), which can be extended to create custom components.
45+
Runtime components of the Content Pipeline support loading and using the transformed game asset by your MonoGame game. These components use the [MonoGame library](../monogame_class_library/index.md), which can be extended to create custom components.
4646

4747
## Content Loader
4848

articles/getting_to_know/whatis/content_pipeline/CP_Overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ When you include an art asset file in your MonoGame solution's content project (
5858

5959
The run-time components of the MonoGame Content Pipeline support the loading and use of the transformed art asset by your MonoGame.
6060

61-
These run-time components make use of the [MonoGame Framework Class Library](../WhatIs_MonoGame_Class_Library.md), which can be extended to create custom Content Pipeline run-time components.
61+
These run-time components make use of the [MonoGame Framework Class Library](../monogame_class_library/index.md), which can be extended to create custom Content Pipeline run-time components.
6262

6363
## See Also
6464

articles/getting_to_know/whatis/content_pipeline/toc.yml

-12
This file was deleted.

0 commit comments

Comments
 (0)