ringcentral-softphone-ts/mkdocs.yml at main · ringcentral/ringcentral-softphone-ts · GitHub

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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# Project information
site_name: RingCentral Cloud Phone SDK
site_url: https://ringcentral.github.io/ringcentral-softphone-ts

# Repository
repo_url: https://github.com/ringcentral/ringcentral-softphone-ts
repo_name: ringcentral/ringcentral-softphone-ts
edit_uri: tree/main/docs
docs_dir: docs

theme:
  name: material
  custom_dir: overrides
  features:
    - navigation.path
    #      - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.expand
    - navigation.sections
    - search.sharing
    - search.highlight
    - content.code.copy
    - content.action.edit
    - content.action.view
    - content.code.annotate
  palette:
    - scheme: default
      primary: custom
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
plugins:
  - material-ringcentral:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - badges
  #  - with-pdf
  - exclude:
      regex:
        - '^\.#.*'
        - '.*\.\#.*$'
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ringcentral
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/ringcentraldevs
extra_css:
  - extra.css

markdown_extensions:
  - attr_list
  - md_in_html
  - mdx_include
  - admonition
  - tables
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji

copyright: "2024-2025 RingCentral, Inc. All rights reserved."

nav:
  - "Home": index.md
  - "Getting stated": get-started.md
  - "Audio": audio.md
  - "Reference":
      - "Cloud Phone":
          - "Events":
              - "invite": reference/invite.md
              - "message": reference/message.md
          - "Methods":
              - "answer()": reference/answer.md
              - "call()": reference/call.md
              - "decline()": reference/decline.md
              - "enableDebugMode()": reference/enableDebugMode.md
      - "Call Session":
          - "Events":
              - "answered": reference/answered.md
              - "audioPacket": reference/audioPacket.md
              - "busy": reference/busy.md
              - "disposed": reference/disposed.md
              - "dtmf": reference/dtmf.md
              - "dtmfPacket": reference/dtmfPacket.md
              - "finished": reference/finished.md
              - "rtpPacket": reference/rtpPacket.md
          - "Methods":
              - "callId()": reference/callId.md
              - "hangup()": reference/hangup.md
              - "send()": reference/send.md
              - "sendDTMF()": reference/sendDtmf.md
              - "sendPacket()": reference/sendPacket.md
              - "streamAudio()": reference/streamAudio.md
              - "transfer()": reference/transfer.md
  - "Examples":
      - "Audio streams":
          - "Record audio": examples/record-audio.md
          - "Stream audio": examples/stream-audio.md
      - "Call control":
          - "Answer call": examples/answer-call.md
          - "Transfer call": examples/transfer-call.md
  - "Support": support.md