Skip to content

Commit ae17424

Browse files
committed
docs(flv): add AVC and HEVC video data factories info on data format
1 parent 6f50703 commit ae17424

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

flv/src/commonJvmAndroid/kotlin/io/github/thibaultbee/krtmp/flv/tags/video/VideoDatasJvmAndroid.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ fun VideoData(
4848
* Creates an AVC/H.264 [LegacyVideoData] fpr a coded frame from a [ByteBuffer].
4949
*
5050
* @param frameType the frame type (key frame or intra frame)
51-
* @param data the coded frame as a [ByteBuffer]
51+
* @param data the coded frame as a [ByteBuffer] in AVCC format (length + NALU)
5252
* @param compositionTime the composition time (24 bits). Default is 0.
5353
* @return the [LegacyVideoData] with the frame
5454
*/
@@ -161,7 +161,7 @@ fun HEVCExtendedVideoDataFactory.sequenceStartByteBuffer(
161161
*
162162
* @param frameType the frame type (key frame or intra frame)
163163
* @param compositionTime the composition time (24 bits).
164-
* @param data the coded frame as a [ByteBuffer]
164+
* @param data the coded frame as a [ByteBuffer] in AVCC format (length + NALU)
165165
* @return the [ExtendedVideoData] with the frame
166166
* @see codedFrameX
167167
*/
@@ -181,7 +181,7 @@ fun AVCHEVCExtendedVideoDataFactory.codedFrame(
181181
* Creates an [ExtendedVideoData] for coded frame from a [ByteBuffer] where composition time is implicitly 0.
182182
*
183183
* @param frameType the frame type (key frame or intra frame)
184-
* @param data the coded frame as a [ByteBuffer]
184+
* @param data the coded frame as a [ByteBuffer] in AVCC format (length + NALU)
185185
* @return the [ExtendedVideoData] with the frame
186186
* @see codedFrame
187187
*/

flv/src/commonMain/kotlin/io/github/thibaultbee/krtmp/flv/tags/video/VideoDatas.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ class AVCVideoDataFactory {
9494
* Creates an AVC/H.264 [LegacyVideoData] for a coded frame from a [RawSource].
9595
*
9696
* @param frameType the frame type (key frame or intra frame)
97-
* @param data the coded frame as a [RawSource]
97+
* @param data the coded frame as a [RawSource] in AVCC format (length + NALU)
9898
* @param dataSize the size of [data]
9999
* @param compositionTime the composition time (24 bits). Default is 0.
100100
* @return the [LegacyVideoData] with the frame
@@ -149,7 +149,7 @@ class AVCVideoDataFactory {
149149
* Creates an AVC/H.264 [LegacyVideoData] for a coded frame from a [ByteArray].
150150
*
151151
* @param frameType the frame type (key frame or intra frame)
152-
* @param data the coded frame as a [ByteArray]
152+
* @param data the coded frame as a [ByteArray] in AVCC format (length + NALU)
153153
* @param compositionTime the composition time (24 bits). Default is 0.
154154
* @return the [LegacyVideoData] with the frame
155155
*/
@@ -412,7 +412,7 @@ sealed class AVCHEVCExtendedVideoDataFactory(fourCC: VideoFourCC) :
412412
* Creates an [ExtendedVideoData] for coded frame from a [RawSource] with composition time.
413413
*
414414
* @param frameType the frame type (key frame or intra frame)
415-
* @param data the coded frame as a [RawSource]
415+
* @param data the coded frame as a [RawSource] in AVCC format (length + NALU)
416416
* @param dataSize the size of the [data]
417417
* @param compositionTime the composition time (24 bits).
418418
* @return the [ExtendedVideoData] with the frame
@@ -433,7 +433,7 @@ sealed class AVCHEVCExtendedVideoDataFactory(fourCC: VideoFourCC) :
433433
* Creates an [ExtendedVideoData] for coded frame from a [RawSource] where composition time is implicitly 0.
434434
*
435435
* @param frameType the frame type (key frame or intra frame)
436-
* @param data the coded frame as a [RawSource]
436+
* @param data the coded frame as a [RawSource] in AVCC format (length + NALU)
437437
* @param dataSize the size of the [data]
438438
* @return the [ExtendedVideoData] with the frame
439439
* @see codedFrame
@@ -456,7 +456,7 @@ sealed class AVCHEVCExtendedVideoDataFactory(fourCC: VideoFourCC) :
456456
*
457457
* @param frameType the frame type (key frame or intra frame)
458458
* @param compositionTime the composition time (24 bits).
459-
* @param data the coded frame as a [ByteArray]
459+
* @param data the coded frame as a [ByteArray] in AVCC format (length + NALU)
460460
* @return the [ExtendedVideoData] with the frame
461461
* @see codedFrameX
462462
*/
@@ -474,7 +474,7 @@ fun AVCHEVCExtendedVideoDataFactory.codedFrame(
474474
* Creates an [ExtendedVideoData] for coded frame from a [ByteArray] where composition time is implicitly 0.
475475
*
476476
* @param frameType the frame type (key frame or intra frame)
477-
* @param data the coded frame as a [ByteArray]
477+
* @param data the coded frame as a [ByteArray] in AVCC format (length + NALU)
478478
* @return the [ExtendedVideoData] with the frame
479479
* @see codedFrame
480480
*/

0 commit comments

Comments
 (0)