Support Request #776
closedADTFS-47123 Several updates on ADTF 3.x documentation
Description
Supportanfrage:
Ein paar Anmerkungen zur Doku von Jochen:
1. auf der Seite doc/adtf_html/page_delivered_system_services.html stehen "ADTF Qt X System Plugin" und "ADTF Log View Plugin" in der Sparte "Session", sollte besser "System" sein.
2. ADTF/3.0.1/doc/adtf_html/page_sample_stream_trace_provider_plugin.html
Die Doku kennt hier einen Service sample_stream_trace_provider.services.adtf.cid. Den gibt es aber nicht, stattdessen heißt er Sample Stream Tracer aus dem Plugin adtf_sample_stream_tracer.adtfplugin
3. Das Bild in ADTF/3.0.1/doc/adtf_html/page_sample.html zum Sample Interface ist veraltet "GetSampleBuffer" gibt es nicht,
Es genügt wohl für eine ungenaue Architektur, aber in der Doku sollte es dann schon passen :)
Best regards - Beste Grüße
Ursula Groh
EB Assist ADTF Support-Team
Lösung:
Folgende Punkte müssen in der Dokumentation angepasst werden:
Auf der Seite doc/adtf_html/page_delivered_system_services.html stehen "ADTF Qt X System Plugin" und "ADTF Log View Plugin" in der Sparte "Session", sollte besser "System" sein.
- "ADTF Qt X System Plugin" und "ADTF Log View Plugin" wurden in der falschen Tabelle eingeordnet und gehören in die Sparte "System".
ADTF/3.0.1/doc/adtf_html/page_sample_stream_trace_provider_plugin.html
Die Doku kennt hier einen Service sample_stream_trace_provider.services.adtf.cid. Den gibt es aber nicht, stattdessen heißt er Sample Stream Tracer aus dem Plugin adtf_sample_stream_tracer.adtfplugin
- Der sample_stream_trace_provider.services.adtf.cid ist an dieser Stelle falsch, er müsste "sample_stream_tracer.services.adtf.cid" heißen.
cFilter
C:/ADTF/3.0.1/doc/adtf_html/classadtf_1_1filter_1_1ant_1_1c_filter.html
ConfigureThreadTrigger(): Hier ist der strPinName fehl am Platze. tFalase sollte wohl tFalse heißen.
ConfigureTimerTrigger(): auch hier taucht zweimal strPinName in der Doku aber nicht als Parameter auf.
Ein Typo in
C:/ADTF/3.0.1/doc/adtf_html/mainpage_mediadescription_pkg.html
#include <adtf_mediadestiption.h>
Bei allen IPC Source Streaming Services fehlt die Dokumentation der Property „synchronize_timestamps“.
Z.B. für den TCP Source C:/ADTF/3.0.1/doc/adtf_html/page_ipc_tcp_plugin.html
Wenn synchronize_timestamps = true wird ein sync2ref auf den Zeitstempel der eingehenden Media Samples gemacht. Das braucht man für den Fall dass die ADTF Instanzen keine synchronisierten Uhren haben. Wenn die Uhren synchronisiert sind (z.b. mithilfe des ADTF Clock Synchronization Services) kann man die Property auf false stellen.
Files