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
Updated by hidden almost 7 years ago
- Project changed from Public Support to 7
- Status changed from New to In Progress
- Topic set to ADTF::Doc
- Customer set to ELEKTROBIT
- Department set to SUPPORT
- Affected Products ADTF 3.0.1 added
- Platform Ubuntu 16.04 64bit, Windows 7 64bit added
Updated by hidden almost 7 years ago
- Subject changed from ADTFS-47123 Die ADTF 3.0.1 Doku stifftet Verwirrung welche Services "Session Services" sind to ADTFS-47123 Die ADTF 3.0.1 Doku stiftet Verwirrung welche Services "Session Services" sind
- Status changed from In Progress to Customer Feedback Required
Hallo Ursula,
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.
Diesen Punkt nehme ich mit in die morgige Projektrunde.Vermutung:
Es wurde bewusst als Session Service eingeordnet wurde, damit es nicht im Runlevel System, sondern im Runlevel Session geladen wird, weil es im Runlevel System noch keine Festerabhängigkeiten (Qt) gibt.
Bereits im Runlevel System können Festerabhängigkeiten geladen werden.
"ADTF Qt X System Plugin" und "ADTF Log View Plugin" wurden in der falschen Tabelle eingeordnet und gehören in die Sparte "System".
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
Der sample_stream_trace_provider.services.adtf.cid ist an dieser Stelle falsch, er müsste "sample_stream_tracer.services.adtf.cid" heißen.
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 :)
Richtig, GetSampleBuffer wurde durch GetSampleBufferFactory() ersetzt.
Updated by hidden almost 7 years ago
Hallo Ursula,
ich habe die Infos aus der Projektrunde im oberen Kommentar ergänzt.
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.
"ADTF Qt X System Plugin" und "ADTF Log View Plugin" wurden in der falschen Tabelle eingeordnet und gehören in die Sparte "System".
Damit sollte dieses Supportticket abgeschlossen sein.
Sobald ich die nötigen Rechte nach dem heutigen Umzug auf JIRA habe, werde ich dementsprechend Tickets für die Anforderungen erstellen bzw. ergänzen.
Updated by hidden almost 7 years ago
- Resolution set to Solved Issue
@Matthias, bitte Ticket nach feedback abschließen und Doku Tickets im JIRA anlegen.
Updated by hidden almost 7 years ago
Hallo,
Ergänzung von Jochen:
noch ein Fehler in der Doku zu cFilter
C:/ADTF/3.0.1/doc/adtf_html/classadtf_1_1filter_1_1ant_1_1c_filter.html
Siehe Attachment:
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.
Updated by hidden almost 7 years ago
- Status changed from Customer Feedback Required to In Progress
Updated by hidden almost 7 years ago
Hallo,
noch ein letzter Nachtrag durch Jochen:
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
Ist mir unklar was das machen soll. Welche timestamps werden synchronisiert und was heißt das überhaupt Zeitstempel zu synchroniseren?
Ein Feature das bei den Streaming Services Sinn machen würde wär ja die Clock-Synchronisation. Ist evtl. das damit gemeint? Dann am besten noch umbennenen.
Updated by hidden almost 7 years ago
- Product Issue Numbers set to https://www.cip.audi.de/jira/browse/ACORE-9142
Hallo zusammen,
für die gemeldeten Punkte wurde ein Produktticket erstellt.
https://www.cip.audi.de/jira/browse/ACORE-9142
Die Frage zu der Property „synchronize_timestamps“ wird noch geklärt.
Updated by hidden almost 7 years ago
- Description updated (diff)
- Status changed from In Progress to Customer Feedback Required
Hallo Zusammen,
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.
Damit sollte dieses Supportticket abgeschlossen sein. Bitte um kurzes Feedback bis spätestens morgen den 21.7.2017.
Updated by hidden almost 7 years ago
Danke,
heutiges Feedback: Bitte noch offen lassen, ich leite es mal an Jochen weiter und warte auf seine Antwort. :)
Viele Grüße
Ursula
Updated by hidden almost 7 years ago
Und ich hab immer noch keinen Zugriff auf die Produktticket-Links...
Viele Grüße
Ursula
Updated by hidden almost 7 years ago
Das Ticket müsste dann unter ID 9142 in dem Ticket Export von Ralf Belke auftauchen?
Updated by hidden almost 7 years ago
Das Ticket müsste dann unter ID 9142 in dem Ticket Export von Ralf Belke auftauchen?
genau
Updated by hidden almost 7 years ago
Passt, könnt das Ticket schließen. Danke :)
Updated by hidden almost 7 years ago
- Description updated (diff)
- Status changed from Customer Feedback Required to To Be Closed
@Florian, Ticket kann geschlossen werden.
Updated by hidden almost 7 years ago
- Resolution changed from Solved Issue to Product Issue Opened
- Subject changed from ADTFS-47123 Die ADTF 3.0.1 Doku stiftet Verwirrung welche Services "Session Services" sind to ADTFS-47123 Several updates on ADTF 3.x documentation
- Status changed from To Be Closed to Closed
Updated by hidden over 6 years ago
- Project changed from 7 to Public Support
- Private changed from Yes to No