teamtalk 6.0.0

TeamTalk SDK for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

#![doc = include_str!("../README.md")]
use std::path::Path;
use utils::ToTT;

#[cfg(feature = "bot")]
pub mod bot;
pub mod client;
pub mod events;
pub mod extensions;
pub mod loader;
pub mod types;
pub mod utils;

#[cfg(feature = "async")]
pub mod async_api;
#[cfg(feature = "dispatch")]
pub mod dispatch;
#[cfg(feature = "logging")]
pub mod logging;
#[cfg(feature = "mock")]
pub mod mock;

#[cfg(feature = "async")]
pub use async_api::{AsyncClient, AsyncConfig};
#[cfg(all(feature = "bot", feature = "bot-redis"))]
pub use bot::RedisStateStore;
#[cfg(all(feature = "bot", feature = "bot-sqlite"))]
pub use bot::SqliteStateStore;
#[cfg(feature = "bot")]
pub use bot::{
    Args, Bot, BotApp, BotBuilder, BotConfig, Command, CommandArgPattern, CommandOnly,
    CommandPattern, CommandPatternError, Context, DialogFlow, DialogMachine, DialogState,
    DialogStatus, DialogTimeoutPolicy, FnMiddleware, HandlerResult, JobErrorPolicy,
    MemoryStateStore, Middleware, Permissions, RateLimitBySource, RequireChannelMessage,
    RequireClientRightsAll, RequireClientRightsAny, RequireCommand, RequireCommandPrefix,
    RequirePrivateMessage, RequireUserIds, RequireUserType, RouteMatcher, Router, Scheduler,
    StateStore, UnknownCommandPolicy, parse_command,
};
#[cfg(all(feature = "bot", feature = "async"))]
pub use bot::{AsyncBot, AsyncBotBuilder, AsyncBotConfig};
pub use client::audio::AudioDeviceProfile;
pub use client::audio::{
    AudioBlockSink, AudioBlockSubscription, AudioBlockView, CallbackSink, UdpSink, WriterSink,
};
pub use client::recording::{
    RecordSession, RecordingOptions, RecordingSampleFormat, RecordingSession, RecordingTarget,
    SilencePolicy, SyncedUserRecording, SyncedUserRecordingBus, SyncedUserRecordingOptions,
    SyncedUserRecordingSession, UserRecordingOptions, UserRecordingSession,
};
pub use client::users::{LoginParams, SendTextOptions};
pub use client::{
    Client, ClientCommands, ClientEvent, ClientEvents, ClientHealth, ClientHooks, ClientInfo,
    ClientManager, ClientRegistry, EventContext, EventData, EventSubscriptionId, Message,
    ReconnectConfig, ReconnectPhaseTimeouts,
};
#[cfg(feature = "state")]
pub use client::{ServerInfo, StoreSnapshot};
#[cfg(feature = "dispatch")]
pub use dispatch::{
    ClientConfig, ConnectParamsOwned, DispatchFlow, Dispatcher,
    EventContext as DispatchEventContext, ReconnectSettings,
};
pub use events::{ConnectionState, Error, Event, Result};
#[cfg(feature = "mock")]
pub use mock::{MockClient, MockMessage, MockUserBuilder};
#[cfg(feature = "bot-macros")]
pub use teamtalk_macros::{
    teamtalk_command, teamtalk_command_help, teamtalk_event, teamtalk_middleware,
};
pub use types::{ClientId, MessageBuilder, UserRights};

/// Initializes the TeamTalk SDK by loading the runtime DLL from the default location.
pub fn init() -> Result<()> {
    let dll_path = loader::find_or_download_dll().map_err(|_| Error::InitFailed)?;
    let dll_path = dll_path.to_str().ok_or(Error::InitFailed)?;
    teamtalk_sys::load(dll_path).map_err(|_| Error::InitFailed)?;
    Ok(())
}

/// Sets TeamTalk license information before creating any `Client`.
///
/// TeamTalk C-API requires license information to be configured before
/// `TT_InitTeamTalk`/`TT_InitTeamTalkPoll`, which in this crate happens inside
/// `Client::new()` and `Client::with_hwnd()`.
pub fn set_license(name: &str, key: &str) -> Result<bool> {
    init()?;
    Ok(unsafe {
        teamtalk_sys::api().TT_SetLicenseInformation(name.tt().as_ptr(), key.tt().as_ptr()) == 1
    })
}

/// Initializes the TeamTalk SDK using a custom DLL path.
pub fn init_with_path<P: AsRef<Path>>(path: P) -> Result<()> {
    teamtalk_sys::load(path.as_ref().to_str().ok_or(Error::InitFailed)?)
        .map_err(|_| Error::InitFailed)?;
    Ok(())
}