Browse Source

Minor comment changes

tags/docs-0.9
Brandon Smith 10 years ago
parent
commit
2c3ed7d4a8
4 changed files with 6 additions and 9 deletions
  1. +1
    -2
      src/Discord.Net/DiscordClient.Voice.cs
  2. +2
    -2
      src/Discord.Net/DiscordClientConfig.cs
  3. +2
    -4
      src/Discord.Net/Models/Channel.cs
  4. +1
    -1
      src/Discord.Net/Models/User.cs

+ 1
- 2
src/Discord.Net/DiscordClient.Voice.cs View File

@@ -31,10 +31,9 @@ namespace Discord
}
}

/// <summary> Sends a PCM frame to the voice server. </summary>
/// <summary> Sends a PCM frame to the voice server. Will block until space frees up in the outgoing buffer. </summary>
/// <param name="data">PCM frame to send. This must be a single or collection of uncompressed 48Kz monochannel 20ms PCM frames. </param>
/// <param name="count">Number of bytes in this frame. </param>
/// <remarks>Will block until</remarks>
public void SendVoicePCM(byte[] data, int count)
{
CheckReady(checkVoice: true);


+ 2
- 2
src/Discord.Net/DiscordClientConfig.cs View File

@@ -24,13 +24,13 @@ namespace Discord
/// <summary> Gets or sets the time (in milliseconds) to wait when the message queue is empty before checking again. </summary>
public int MessageQueueInterval { get { return _messageQueueInterval; } set { SetValue(ref _messageQueueInterval, value); } }
private int _messageQueueInterval = 100;
/// <summary> Gets or sets the max buffer length (in milliseconds) for outgoing voice packets. This value is the target maximum but is not guaranteed, the buffer will often go slightly above this value. </remarks>
/// <summary> Gets or sets the max buffer length (in milliseconds) for outgoing voice packets. This value is the target maximum but is not guaranteed, the buffer will often go slightly above this value. </summary>
public int VoiceBufferLength { get { return _voiceBufferLength; } set { SetValue(ref _voiceBufferLength, value); } }
private int _voiceBufferLength = 3000;

//Experimental Features
#if !DNXCORE50
/// <summary> (Experimental) Enables the voice websocket and UDP client. This option requires the opus .dll or .so be in the local lib/ folder. </remarks>
/// <summary> (Experimental) Enables the voice websocket and UDP client. This option requires the opus .dll or .so be in the local lib/ folder. </summary>
public bool EnableVoice { get { return _enableVoice; } set { SetValue(ref _enableVoice, value); } }
private bool _enableVoice = false;
#else


+ 2
- 4
src/Discord.Net/Models/Channel.cs View File

@@ -45,12 +45,10 @@ namespace Discord
[JsonIgnore]
public User Recipient => _client.Users[RecipientId];

/// <summary> Returns a collection of the ids of all messages the client has seen posted in this channel. </summary>
/// <remarks> This collection does not guarantee any ordering. </remarks>
/// <summary> Returns a collection of the ids of all messages the client has seen posted in this channel. This collection does not guarantee any ordering. </summary>
[JsonIgnore]
public IEnumerable<string> MessageIds => _messages.Select(x => x.Key);
/// <summary> Returns a collection of all messages the client has seen posted in this channel. </summary>
/// <remarks> This collection does not guarantee any ordering. </remarks>
/// <summary> Returns a collection of all messages the client has seen posted in this channel. This collection does not guarantee any ordering. </summary>
[JsonIgnore]
public IEnumerable<Message> Messages => _messages.Select(x => _client.Messages[x.Key]);



+ 1
- 1
src/Discord.Net/Models/User.cs View File

@@ -47,7 +47,7 @@ namespace Discord

//TODO: Add voice triggering LastActivity
/// <summary> Returns the time this user last sent a message. </summary>
/// <remarks> Is not currently affected by voice activity </remarks>
/// <remarks> Is not currently affected by voice activity. </remarks>
public DateTime LastActivity { get; private set; }

internal User(DiscordClient client, string id)


Loading…
Cancel
Save