Skip to content

Commit d6df48b

Browse files
committed
docs: fix README structure
1 parent 5dd931d commit d6df48b

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ if (permissionStatus === FrameCapture.PermissionStatus.GRANTED) {
128128

129129
### Permission Management
130130

131-
### `requestPermission()`
131+
#### `requestPermission()`
132132

133133
Requests **MediaProjection permission** (screen capture/screen sharing) from the user. This opens the Android system dialog asking the user to allow screen recording.
134134

@@ -142,7 +142,7 @@ const status = await FrameCapture.requestPermission();
142142

143143
**Note:** This is a runtime permission that must be granted before starting capture. The permission dialog is shown by the Android system, not your app.
144144

145-
### `checkPermission()`
145+
#### `checkPermission()`
146146

147147
Checks if MediaProjection permission (screen capture) has been previously granted without showing the permission dialog.
148148

@@ -154,7 +154,7 @@ const status = await FrameCapture.checkPermission();
154154

155155
**Note:** Returns `NOT_DETERMINED` if permission was never requested, `GRANTED` if previously granted. MediaProjection permission cannot be checked programmatically on Android, so this only verifies if permission data exists from a previous grant.
156156

157-
### `checkNotificationPermission()`
157+
#### `checkNotificationPermission()`
158158

159159
Checks if notification permission is granted (Android 13+).
160160

@@ -166,7 +166,7 @@ const status = await FrameCapture.checkNotificationPermission();
166166

167167
### Capture Control
168168

169-
### `startCapture(options)`
169+
#### `startCapture(options)`
170170

171171
Starts screen capture with the specified options.
172172

@@ -190,7 +190,7 @@ const session = await FrameCapture.startCapture({
190190

191191
**Throws:** `CaptureError` if capture cannot be started
192192

193-
### `stopCapture()`
193+
#### `stopCapture()`
194194

195195
Stops the active capture session.
196196

@@ -200,7 +200,7 @@ await FrameCapture.stopCapture();
200200

201201
**Returns:** `Promise<void>`
202202

203-
### `pauseCapture()`
203+
#### `pauseCapture()`
204204

205205
Pauses the active capture session.
206206

@@ -210,7 +210,7 @@ await FrameCapture.pauseCapture();
210210

211211
**Returns:** `Promise<void>`
212212

213-
### `resumeCapture()`
213+
#### `resumeCapture()`
214214

215215
Resumes a paused capture session.
216216

@@ -220,7 +220,7 @@ await FrameCapture.resumeCapture();
220220

221221
**Returns:** `Promise<void>`
222222

223-
### `getCaptureStatus()`
223+
#### `getCaptureStatus()`
224224

225225
Gets the current capture status.
226226

@@ -233,7 +233,7 @@ console.log(status.state); // 'idle' | 'capturing' | 'paused'
233233

234234
### Utility Functions
235235

236-
### `cleanupTempFrames()`
236+
#### `cleanupTempFrames()`
237237

238238
Manually cleans up all temporary frame files stored in the app's cache directory.
239239

@@ -256,7 +256,7 @@ await FrameCapture.cleanupTempFrames();
256256
- After processing frames in your app
257257
- When you want to free up cache storage manually
258258

259-
### `addListener(eventType, callback)`
259+
#### `addListener(eventType, callback)`
260260

261261
Adds an event listener for capture events.
262262

0 commit comments

Comments
 (0)