Network Ingest Debugging

When encountering problems with a stream that you are ingesting, a practical strategy to identify the issue is to compare the source encoder's metadata.

RTMP Metadata

The KB encoder adds some metadata to the output RTMP streams (output metadata). The received metadata from a RTMP input (input metadata) is passed-through to the KB transcoder.

Note

The onMetaData object information must be sent in the first packet upon initial start and on any restart events.

The following tables are divided into:

Common Values
Video-Related Values
Audio-Related Values

The "Overwritten?" column identifies if an input metadata value is overwritten by the transcoder. Any value that appears with a "src_" prefix in the metadata is a setting of the source encoder.

Common Values

Name	Type	Description	Overwritten?	Version
startDate	string	Encode start date.	No	4.3+
startTime	string	Encode start time.	No	4.3+
title	string	Stream title, default is an empty string "".	Yes	4.3+
author	string	Stream author, default is an empty string "".	Yes	4.3+
description	string	Stream description, default is an empty string "".	Yes	4.3+
keywords	string	Stream keywords, default is an empty string "".	Yes	4.3+
rating	string	Stream rating, default is an empty string "".	Yes	4.3+
copyright	string	Stream copyright, default is an empty string "".	Yes	4.3+
sourcetype	string	What source is used.	No	4.3+
presetname	string	The used channel configuration name.	No	4.3+
creationdate	string	Stream creation date, Default is an empty string "".	Yes	4.3+

Video-Related Values

Name	Type	Description	Overwritten?	Version
videodevice	string	Empty string "".	No	4.3+
videocodecid	string	It's usually set to "avc1" for H.264.	No	4.3+
videoonly	number	Is set to 1 if the stream contains only video.	Yes	4.3+
framerate	number	Video framerate in frames per second.	No	4.3+
width	number	Video width in pixels.	No	4.3+
height	number	Video height in pixels.	No	4.3+
videodatarate	number	Video data rate in kBits per second.	No	4.3+
avcprofile	number	AVC/H.264 profile.	No	4.3+
avclevel	number	AVC/H.264 level.	No	4.3+
videokeyframe_frequency	number	Distance between key-frames in number of frames.	No	4.3+

Audio-Related Values

Name	Type	Description	Overwritten?	Version
audiodevice	string	Empty string "".	No	4.3+
audiocodecid	string	Typically set to "aac" for AAC.	No	4.3+
audioonly	number	Is set to 1 if the stream contains only audio data.	Yes	4.3+
audiosamplerate	number	Audio sample in samples per second.	No	4.3+
audiosamplesize	number	Audio sample size in bits.	Yes	4.3+
audiochannels	number	Count of audio channels.	No	4.3+
audiodatarate	number	Audio bitrate in kBits per second.	No	4.3+
stereo	number	Is set to 1 if the audio signal is stereo.	Yes	4.3+
aacaot	number	Audio object type.	Yes	4.3+
audioinputvolume	number	Audio input volume in dB.	No	4.3+