123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560 |
- <?xml version="1.0"?>
- <!-- This file was automatically generated from C sources - DO NOT EDIT!
- To affect the contents of this file, edit the original C definitions,
- and/or use gtk-doc annotations. -->
- <repository version="1.2"
- xmlns="http://www.gtk.org/introspection/core/1.0"
- xmlns:c="http://www.gtk.org/introspection/c/1.0"
- xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
- <include name="Gst" version="1.0"/>
- <include name="GstBase" version="1.0"/>
- <package name="gstreamer-rtp-1.0"/>
- <c:include name="gst/rtp/rtp.h"/>
- <namespace name="GstRtp"
- version="1.0"
- shared-library="libgstrtp-1.0.so.0"
- c:identifier-prefixes="Gst"
- c:symbol-prefixes="gst">
- <record name="RTCPBuffer" c:type="GstRTCPBuffer">
- <doc xml:space="preserve">Note: The API in this module is not yet declared stable.
- <refsect2>
- <para>
- The GstRTPCBuffer helper functions makes it easy to parse and create regular
- #GstBuffer objects that contain compound RTCP packets. These buffers are typically
- of 'application/x-rtcp' #GstCaps.
- </para>
- <para>
- An RTCP buffer consists of 1 or more #GstRTCPPacket structures that you can
- retrieve with gst_rtcp_buffer_get_first_packet(). #GstRTCPPacket acts as a pointer
- into the RTCP buffer; you can move to the next packet with
- gst_rtcp_packet_move_to_next().
- </para>
- </refsect2></doc>
- <field name="buffer" writable="1">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="map" writable="1">
- <type name="Gst.MapInfo" c:type="GstMapInfo"/>
- </field>
- <method name="add_packet" c:identifier="gst_rtcp_buffer_add_packet">
- <doc xml:space="preserve">Add a new packet of @type to @rtcp. @packet will point to the newly created
- packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the packet could be created. This function returns %FALSE
- if the max mtu is exceeded for the buffer.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTCP buffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">the #GstRTCPType of the new packet</doc>
- <type name="RTCPType" c:type="GstRTCPType"/>
- </parameter>
- <parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">pointer to new packet</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_first_packet"
- c:identifier="gst_rtcp_buffer_get_first_packet">
- <doc xml:space="preserve">Initialize a new #GstRTCPPacket pointer that points to the first packet in
- @rtcp.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if the packet existed in @rtcp.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTCP buffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </instance-parameter>
- <parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_packet_count"
- c:identifier="gst_rtcp_buffer_get_packet_count">
- <doc xml:space="preserve">Get the number of RTCP packets in @rtcp.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the number of RTCP packets in @rtcp.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTCP buffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="unmap" c:identifier="gst_rtcp_buffer_unmap">
- <doc xml:space="preserve">Finish @rtcp after being constructed. This function is usually called
- after gst_rtcp_buffer_map() and after adding the RTCP items to the new buffer.
- The function adjusts the size of @rtcp with the total length of all the
- added packets.</doc>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve">a buffer with an RTCP packet</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="map" c:identifier="gst_rtcp_buffer_map">
- <doc xml:space="preserve">Open @buffer for reading or writing, depending on @flags. The resulting RTCP
- buffer state is stored in @rtcp.</doc>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">a buffer with an RTCP packet</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve">flags for the mapping</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- <parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve">resulting #GstRTCPBuffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="new" c:identifier="gst_rtcp_buffer_new">
- <doc xml:space="preserve">Create a new buffer for constructing RTCP packets. The packet will have a
- maximum size of @mtu.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="mtu" transfer-ownership="none">
- <doc xml:space="preserve">the maximum mtu size.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_copy_data"
- c:identifier="gst_rtcp_buffer_new_copy_data">
- <doc xml:space="preserve">Create a new buffer and set the data to a copy of @len
- bytes of @data and the size to @len. The data will be freed when the buffer
- is freed.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer with a copy of @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_take_data"
- c:identifier="gst_rtcp_buffer_new_take_data">
- <doc xml:space="preserve">Create a new buffer and set the data and size of the buffer to @data and @len
- respectively. @data will be freed when the buffer is unreffed, so this
- function transfers ownership of @data to the new buffer.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer with @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="validate" c:identifier="gst_rtcp_buffer_validate">
- <doc xml:space="preserve">Check if the data pointed to by @buffer is a valid RTCP packet using
- gst_rtcp_buffer_validate_data().</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @buffer is a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">the buffer to validate</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="validate_data"
- c:identifier="gst_rtcp_buffer_validate_data">
- <doc xml:space="preserve">Check if the @data and @size point to the data of a valid compound,
- non-reduced size RTCP packet.
- Use this function to validate a packet before using the other functions in
- this module.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if the data points to a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">the data to validate</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of @data to validate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="validate_data_reduced"
- c:identifier="gst_rtcp_buffer_validate_data_reduced"
- version="1.6">
- <doc xml:space="preserve">Check if the @data and @size point to the data of a valid RTCP packet.
- Use this function to validate a packet before using the other functions in
- this module.
- This function is updated to support reduced size rtcp packets according to
- RFC 5506 and will validate full compound RTCP packets as well as reduced
- size RTCP packets.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if the data points to a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">the data to validate</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of @data to validate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="validate_reduced"
- c:identifier="gst_rtcp_buffer_validate_reduced"
- version="1.6">
- <doc xml:space="preserve">Check if the data pointed to by @buffer is a valid RTCP packet using
- gst_rtcp_buffer_validate_reduced().</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @buffer is a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">the buffer to validate</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <enumeration name="RTCPFBType"
- glib:type-name="GstRTCPFBType"
- glib:get-type="gst_rtcpfb_type_get_type"
- c:type="GstRTCPFBType">
- <doc xml:space="preserve">Different types of feedback messages.</doc>
- <member name="fb_type_invalid"
- value="0"
- c:identifier="GST_RTCP_FB_TYPE_INVALID"
- glib:nick="fb-type-invalid">
- <doc xml:space="preserve">Invalid type</doc>
- </member>
- <member name="rtpfb_type_nack"
- value="1"
- c:identifier="GST_RTCP_RTPFB_TYPE_NACK"
- glib:nick="rtpfb-type-nack">
- <doc xml:space="preserve">Generic NACK</doc>
- </member>
- <member name="rtpfb_type_tmmbr"
- value="3"
- c:identifier="GST_RTCP_RTPFB_TYPE_TMMBR"
- glib:nick="rtpfb-type-tmmbr">
- <doc xml:space="preserve">Temporary Maximum Media Stream Bit Rate Request</doc>
- </member>
- <member name="rtpfb_type_tmmbn"
- value="4"
- c:identifier="GST_RTCP_RTPFB_TYPE_TMMBN"
- glib:nick="rtpfb-type-tmmbn">
- <doc xml:space="preserve">Temporary Maximum Media Stream Bit Rate
- Notification</doc>
- </member>
- <member name="rtpfb_type_rtcp_sr_req"
- value="5"
- c:identifier="GST_RTCP_RTPFB_TYPE_RTCP_SR_REQ"
- glib:nick="rtpfb-type-rtcp-sr-req">
- <doc xml:space="preserve">Request an SR packet for early
- synchronization</doc>
- </member>
- <member name="psfb_type_pli"
- value="1"
- c:identifier="GST_RTCP_PSFB_TYPE_PLI"
- glib:nick="psfb-type-pli">
- <doc xml:space="preserve">Picture Loss Indication</doc>
- </member>
- <member name="psfb_type_sli"
- value="2"
- c:identifier="GST_RTCP_PSFB_TYPE_SLI"
- glib:nick="psfb-type-sli">
- <doc xml:space="preserve">Slice Loss Indication</doc>
- </member>
- <member name="psfb_type_rpsi"
- value="3"
- c:identifier="GST_RTCP_PSFB_TYPE_RPSI"
- glib:nick="psfb-type-rpsi">
- <doc xml:space="preserve">Reference Picture Selection Indication</doc>
- </member>
- <member name="psfb_type_afb"
- value="15"
- c:identifier="GST_RTCP_PSFB_TYPE_AFB"
- glib:nick="psfb-type-afb">
- <doc xml:space="preserve">Application layer Feedback</doc>
- </member>
- <member name="psfb_type_fir"
- value="4"
- c:identifier="GST_RTCP_PSFB_TYPE_FIR"
- glib:nick="psfb-type-fir">
- <doc xml:space="preserve">Full Intra Request Command</doc>
- </member>
- <member name="psfb_type_tstr"
- value="5"
- c:identifier="GST_RTCP_PSFB_TYPE_TSTR"
- glib:nick="psfb-type-tstr">
- <doc xml:space="preserve">Temporal-Spatial Trade-off Request</doc>
- </member>
- <member name="psfb_type_tstn"
- value="6"
- c:identifier="GST_RTCP_PSFB_TYPE_TSTN"
- glib:nick="psfb-type-tstn">
- <doc xml:space="preserve">Temporal-Spatial Trade-off Notification</doc>
- </member>
- <member name="psfb_type_vbcn"
- value="7"
- c:identifier="GST_RTCP_PSFB_TYPE_VBCN"
- glib:nick="psfb-type-vbcn">
- <doc xml:space="preserve">Video Back Channel Message</doc>
- </member>
- </enumeration>
- <record name="RTCPPacket" c:type="GstRTCPPacket">
- <doc xml:space="preserve">Data structure that points to a packet at @offset in @buffer.
- The size of the structure is made public to allow stack allocations.</doc>
- <field name="rtcp" writable="1">
- <doc xml:space="preserve">pointer to RTCP buffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </field>
- <field name="offset" writable="1">
- <doc xml:space="preserve">offset of packet in buffer data</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="padding" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="count" readable="0" private="1">
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="type" readable="0" private="1">
- <type name="RTCPType" c:type="GstRTCPType"/>
- </field>
- <field name="length" readable="0" private="1">
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="item_offset" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="item_count" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="entry_offset" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <method name="add_rb" c:identifier="gst_rtcp_packet_add_rb">
- <doc xml:space="preserve">Add a new report block to @packet with the given values.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the packet was created. This function can return %FALSE if
- the max MTU is exceeded or the number of report blocks is greater than
- #GST_RTCP_MAX_RB_COUNT.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">data source being reported</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="fractionlost" transfer-ownership="none">
- <doc xml:space="preserve">fraction lost since last SR/RR</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="packetslost" transfer-ownership="none">
- <doc xml:space="preserve">the cumululative number of packets lost</doc>
- <type name="gint32" c:type="gint32"/>
- </parameter>
- <parameter name="exthighestseq" transfer-ownership="none">
- <doc xml:space="preserve">the extended last sequence number received</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="jitter" transfer-ownership="none">
- <doc xml:space="preserve">the interarrival jitter</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="lsr" transfer-ownership="none">
- <doc xml:space="preserve">the last SR packet from this source</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="dlsr" transfer-ownership="none">
- <doc xml:space="preserve">the delay since last SR packet</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="bye_add_ssrc" c:identifier="gst_rtcp_packet_bye_add_ssrc">
- <doc xml:space="preserve">Add @ssrc to the BYE @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the ssrc was added. This function can return %FALSE if
- the max MTU is exceeded or the number of sources blocks is greater than
- #GST_RTCP_MAX_BYE_SSRC_COUNT.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">an SSRC to add</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="bye_add_ssrcs"
- c:identifier="gst_rtcp_packet_bye_add_ssrcs">
- <doc xml:space="preserve">Adds @len SSRCs in @ssrc to BYE @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the all the SSRCs were added. This function can return %FALSE if
- the max MTU is exceeded or the number of sources blocks is greater than
- #GST_RTCP_MAX_BYE_SSRC_COUNT.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">an array of SSRCs to add</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">number of elements in @ssrc</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="bye_get_nth_ssrc"
- c:identifier="gst_rtcp_packet_bye_get_nth_ssrc">
- <doc xml:space="preserve">Get the @nth SSRC of the BYE @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The @nth SSRC of @packet.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve">the nth SSRC to get</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="bye_get_reason"
- c:identifier="gst_rtcp_packet_bye_get_reason">
- <doc xml:space="preserve">Get the reason in @packet.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">The reason for the BYE @packet or NULL if the packet did not contain
- a reason string. The string must be freed with g_free() after usage.</doc>
- <type name="utf8" c:type="gchar*"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="bye_get_reason_len"
- c:identifier="gst_rtcp_packet_bye_get_reason_len">
- <doc xml:space="preserve">Get the length of the reason string.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The length of the reason string or 0 when there is no reason string
- present.</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="bye_get_ssrc_count"
- c:identifier="gst_rtcp_packet_bye_get_ssrc_count">
- <doc xml:space="preserve">Get the number of SSRC fields in @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The number of SSRC fields in @packet.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="bye_set_reason"
- c:identifier="gst_rtcp_packet_bye_set_reason">
- <doc xml:space="preserve">Set the reason string to @reason in @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if the string could be set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid BYE #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="reason" transfer-ownership="none">
- <doc xml:space="preserve">a reason string</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </method>
- <method name="fb_get_fci" c:identifier="gst_rtcp_packet_fb_get_fci">
- <doc xml:space="preserve">Get the Feedback Control Information attached to a RTPFB or PSFB @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a pointer to the FCI</doc>
- <type name="guint8" c:type="guint8*"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="fb_get_fci_length"
- c:identifier="gst_rtcp_packet_fb_get_fci_length">
- <doc xml:space="preserve">Get the length of the Feedback Control Information attached to a
- RTPFB or PSFB @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The length of the FCI in 32-bit words.</doc>
- <type name="guint16" c:type="guint16"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="fb_get_media_ssrc"
- c:identifier="gst_rtcp_packet_fb_get_media_ssrc">
- <doc xml:space="preserve">Get the media SSRC field of the RTPFB or PSFB @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the media SSRC.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="fb_get_sender_ssrc"
- c:identifier="gst_rtcp_packet_fb_get_sender_ssrc">
- <doc xml:space="preserve">Get the sender SSRC field of the RTPFB or PSFB @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the sender SSRC.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="fb_get_type" c:identifier="gst_rtcp_packet_fb_get_type">
- <doc xml:space="preserve">Get the feedback message type of the FB @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The feedback message type.</doc>
- <type name="RTCPFBType" c:type="GstRTCPFBType"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="fb_set_fci_length"
- c:identifier="gst_rtcp_packet_fb_set_fci_length">
- <doc xml:space="preserve">Set the length of the Feedback Control Information attached to a
- RTPFB or PSFB @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if there was enough space in the packet to add this much FCI</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="wordlen" transfer-ownership="none">
- <doc xml:space="preserve">Length of the FCI in 32-bit words</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </method>
- <method name="fb_set_media_ssrc"
- c:identifier="gst_rtcp_packet_fb_set_media_ssrc">
- <doc xml:space="preserve">Set the media SSRC field of the RTPFB or PSFB @packet.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">a media SSRC</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="fb_set_sender_ssrc"
- c:identifier="gst_rtcp_packet_fb_set_sender_ssrc">
- <doc xml:space="preserve">Set the sender SSRC field of the RTPFB or PSFB @packet.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">a sender SSRC</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="fb_set_type" c:identifier="gst_rtcp_packet_fb_set_type">
- <doc xml:space="preserve">Set the feedback message type of the FB @packet.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid RTPFB or PSFB #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">the #GstRTCPFBType to set</doc>
- <type name="RTCPFBType" c:type="GstRTCPFBType"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_count" c:identifier="gst_rtcp_packet_get_count">
- <doc xml:space="preserve">Get the count field in @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The count field in @packet or -1 if @packet does not point to a
- valid packet.</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_length" c:identifier="gst_rtcp_packet_get_length">
- <doc xml:space="preserve">Get the length field of @packet. This is the length of the packet in
- 32-bit words minus one.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The length field of @packet.</doc>
- <type name="guint16" c:type="guint16"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_padding" c:identifier="gst_rtcp_packet_get_padding">
- <doc xml:space="preserve">Get the packet padding of the packet pointed to by @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">If the packet has the padding bit set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_rb" c:identifier="gst_rtcp_packet_get_rb">
- <doc xml:space="preserve">Parse the values of the @nth report block in @packet and store the result in
- the values.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve">the nth report block in @packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">result for data source being reported</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="fractionlost" transfer-ownership="none">
- <doc xml:space="preserve">result for fraction lost since last SR/RR</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="packetslost" transfer-ownership="none">
- <doc xml:space="preserve">result for the cumululative number of packets lost</doc>
- <type name="gint32" c:type="gint32*"/>
- </parameter>
- <parameter name="exthighestseq" transfer-ownership="none">
- <doc xml:space="preserve">result for the extended last sequence number received</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="jitter" transfer-ownership="none">
- <doc xml:space="preserve">result for the interarrival jitter</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="lsr" transfer-ownership="none">
- <doc xml:space="preserve">result for the last SR packet from this source</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="dlsr" transfer-ownership="none">
- <doc xml:space="preserve">result for the delay since last SR packet</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_rb_count" c:identifier="gst_rtcp_packet_get_rb_count">
- <doc xml:space="preserve">Get the number of report blocks in @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The number of report blocks in @packet.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_type" c:identifier="gst_rtcp_packet_get_type">
- <doc xml:space="preserve">Get the packet type of the packet pointed to by @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The packet type or GST_RTCP_TYPE_INVALID when @packet is not
- pointing to a valid packet.</doc>
- <type name="RTCPType" c:type="GstRTCPType"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="move_to_next" c:identifier="gst_rtcp_packet_move_to_next">
- <doc xml:space="preserve">Move the packet pointer @packet to the next packet in the payload.
- Use gst_rtcp_buffer_get_first_packet() to initialize @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @packet is pointing to a valid packet after calling this
- function.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="remove" c:identifier="gst_rtcp_packet_remove">
- <doc xml:space="preserve">Removes the packet pointed to by @packet and moves pointer to the next one</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @packet is pointing to a valid packet after calling this
- function.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="rr_get_ssrc" c:identifier="gst_rtcp_packet_rr_get_ssrc">
- <doc xml:space="preserve">Get the ssrc field of the RR @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the ssrc.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="rr_set_ssrc" c:identifier="gst_rtcp_packet_rr_set_ssrc">
- <doc xml:space="preserve">Set the ssrc field of the RR @packet.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">the SSRC to set</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="sdes_add_entry"
- c:identifier="gst_rtcp_packet_sdes_add_entry">
- <doc xml:space="preserve">Add a new SDES entry to the current item in @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the item could be added, %FALSE if the MTU has been
- reached.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">the #GstRTCPSDESType of the SDES entry</doc>
- <type name="RTCPSDESType" c:type="GstRTCPSDESType"/>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the data length</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">the data</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="sdes_add_item"
- c:identifier="gst_rtcp_packet_sdes_add_item">
- <doc xml:space="preserve">Add a new SDES item for @ssrc to @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the item could be added, %FALSE if the maximum amount of
- items has been exceeded for the SDES packet or the MTU has been reached.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">the SSRC of the new item to add</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="sdes_copy_entry"
- c:identifier="gst_rtcp_packet_sdes_copy_entry">
- <doc xml:space="preserve">This function is like gst_rtcp_packet_sdes_get_entry() but it returns a
- null-terminated copy of the data instead. use g_free() after usage.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if there was valid data.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">result of the entry type</doc>
- <type name="RTCPSDESType" c:type="GstRTCPSDESType*"/>
- </parameter>
- <parameter name="len"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">result length of the entry data</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">result entry data</doc>
- <array length="1" zero-terminated="0" c:type="guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="sdes_first_entry"
- c:identifier="gst_rtcp_packet_sdes_first_entry">
- <doc xml:space="preserve">Move to the first SDES entry in the current item.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if there was a first entry.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sdes_first_item"
- c:identifier="gst_rtcp_packet_sdes_first_item">
- <doc xml:space="preserve">Move to the first SDES item in @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if there was a first item.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sdes_get_entry"
- c:identifier="gst_rtcp_packet_sdes_get_entry">
- <doc xml:space="preserve">Get the data of the current SDES item entry. @type (when not NULL) will
- contain the type of the entry. @data (when not NULL) will point to @len
- bytes.
- When @type refers to a text item, @data will point to a UTF8 string. Note
- that this UTF8 string is NOT null-terminated. Use
- gst_rtcp_packet_sdes_copy_entry() to get a null-terminated copy of the entry.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if there was valid data.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">result of the entry type</doc>
- <type name="RTCPSDESType" c:type="GstRTCPSDESType*"/>
- </parameter>
- <parameter name="len"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">result length of the entry data</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve">result entry data</doc>
- <array length="1" zero-terminated="0" c:type="guint8**">
- <type name="guint8" c:type="guint8*"/>
- </array>
- </parameter>
- </parameters>
- </method>
- <method name="sdes_get_item_count"
- c:identifier="gst_rtcp_packet_sdes_get_item_count">
- <doc xml:space="preserve">Get the number of items in the SDES packet @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The number of items in @packet.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sdes_get_ssrc"
- c:identifier="gst_rtcp_packet_sdes_get_ssrc">
- <doc xml:space="preserve">Get the SSRC of the current SDES item.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the SSRC of the current item.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sdes_next_entry"
- c:identifier="gst_rtcp_packet_sdes_next_entry">
- <doc xml:space="preserve">Move to the next SDES entry in the current item.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if there was a next entry.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="sdes_next_item"
- c:identifier="gst_rtcp_packet_sdes_next_item">
- <doc xml:space="preserve">Move to the next SDES item in @packet.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if there was a next item.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SDES #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_rb" c:identifier="gst_rtcp_packet_set_rb">
- <doc xml:space="preserve">Set the @nth new report block in @packet with the given values.
- Note: Not implemented.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SR or RR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve">the nth report block to set</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">data source being reported</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="fractionlost" transfer-ownership="none">
- <doc xml:space="preserve">fraction lost since last SR/RR</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="packetslost" transfer-ownership="none">
- <doc xml:space="preserve">the cumululative number of packets lost</doc>
- <type name="gint32" c:type="gint32"/>
- </parameter>
- <parameter name="exthighestseq" transfer-ownership="none">
- <doc xml:space="preserve">the extended last sequence number received</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="jitter" transfer-ownership="none">
- <doc xml:space="preserve">the interarrival jitter</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="lsr" transfer-ownership="none">
- <doc xml:space="preserve">the last SR packet from this source</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="dlsr" transfer-ownership="none">
- <doc xml:space="preserve">the delay since last SR packet</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="sr_get_sender_info"
- c:identifier="gst_rtcp_packet_sr_get_sender_info">
- <doc xml:space="preserve">Parse the SR sender info and store the values.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">result SSRC</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="ntptime" transfer-ownership="none">
- <doc xml:space="preserve">result NTP time</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="rtptime" transfer-ownership="none">
- <doc xml:space="preserve">result RTP time</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="packet_count" transfer-ownership="none">
- <doc xml:space="preserve">result packet count</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- <parameter name="octet_count" transfer-ownership="none">
- <doc xml:space="preserve">result octet count</doc>
- <type name="guint32" c:type="guint32*"/>
- </parameter>
- </parameters>
- </method>
- <method name="sr_set_sender_info"
- c:identifier="gst_rtcp_packet_sr_set_sender_info">
- <doc xml:space="preserve">Set the given values in the SR packet @packet.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="packet" transfer-ownership="none">
- <doc xml:space="preserve">a valid SR #GstRTCPPacket</doc>
- <type name="RTCPPacket" c:type="GstRTCPPacket*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">the SSRC</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="ntptime" transfer-ownership="none">
- <doc xml:space="preserve">the NTP time</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- <parameter name="rtptime" transfer-ownership="none">
- <doc xml:space="preserve">the RTP time</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="packet_count" transfer-ownership="none">
- <doc xml:space="preserve">the packet count</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- <parameter name="octet_count" transfer-ownership="none">
- <doc xml:space="preserve">the octet count</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- </record>
- <enumeration name="RTCPSDESType"
- glib:type-name="GstRTCPSDESType"
- glib:get-type="gst_rtcpsdes_type_get_type"
- c:type="GstRTCPSDESType">
- <doc xml:space="preserve">Different types of SDES content.</doc>
- <member name="invalid"
- value="-1"
- c:identifier="GST_RTCP_SDES_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve">Invalid SDES entry</doc>
- </member>
- <member name="end"
- value="0"
- c:identifier="GST_RTCP_SDES_END"
- glib:nick="end">
- <doc xml:space="preserve">End of SDES list</doc>
- </member>
- <member name="cname"
- value="1"
- c:identifier="GST_RTCP_SDES_CNAME"
- glib:nick="cname">
- <doc xml:space="preserve">Canonical name</doc>
- </member>
- <member name="name"
- value="2"
- c:identifier="GST_RTCP_SDES_NAME"
- glib:nick="name">
- <doc xml:space="preserve">User name</doc>
- </member>
- <member name="email"
- value="3"
- c:identifier="GST_RTCP_SDES_EMAIL"
- glib:nick="email">
- <doc xml:space="preserve">User's electronic mail address</doc>
- </member>
- <member name="phone"
- value="4"
- c:identifier="GST_RTCP_SDES_PHONE"
- glib:nick="phone">
- <doc xml:space="preserve">User's phone number</doc>
- </member>
- <member name="loc"
- value="5"
- c:identifier="GST_RTCP_SDES_LOC"
- glib:nick="loc">
- <doc xml:space="preserve">Geographic user location</doc>
- </member>
- <member name="tool"
- value="6"
- c:identifier="GST_RTCP_SDES_TOOL"
- glib:nick="tool">
- <doc xml:space="preserve">Name of application or tool</doc>
- </member>
- <member name="note"
- value="7"
- c:identifier="GST_RTCP_SDES_NOTE"
- glib:nick="note">
- <doc xml:space="preserve">Notice about the source</doc>
- </member>
- <member name="priv"
- value="8"
- c:identifier="GST_RTCP_SDES_PRIV"
- glib:nick="priv">
- <doc xml:space="preserve">Private extensions</doc>
- </member>
- </enumeration>
- <enumeration name="RTCPType"
- glib:type-name="GstRTCPType"
- glib:get-type="gst_rtcp_type_get_type"
- c:type="GstRTCPType">
- <doc xml:space="preserve">Different RTCP packet types.</doc>
- <member name="invalid"
- value="0"
- c:identifier="GST_RTCP_TYPE_INVALID"
- glib:nick="invalid">
- <doc xml:space="preserve">Invalid type</doc>
- </member>
- <member name="sr"
- value="200"
- c:identifier="GST_RTCP_TYPE_SR"
- glib:nick="sr">
- <doc xml:space="preserve">Sender report</doc>
- </member>
- <member name="rr"
- value="201"
- c:identifier="GST_RTCP_TYPE_RR"
- glib:nick="rr">
- <doc xml:space="preserve">Receiver report</doc>
- </member>
- <member name="sdes"
- value="202"
- c:identifier="GST_RTCP_TYPE_SDES"
- glib:nick="sdes">
- <doc xml:space="preserve">Source description</doc>
- </member>
- <member name="bye"
- value="203"
- c:identifier="GST_RTCP_TYPE_BYE"
- glib:nick="bye">
- <doc xml:space="preserve">Goodbye</doc>
- </member>
- <member name="app"
- value="204"
- c:identifier="GST_RTCP_TYPE_APP"
- glib:nick="app">
- <doc xml:space="preserve">Application defined</doc>
- </member>
- <member name="rtpfb"
- value="205"
- c:identifier="GST_RTCP_TYPE_RTPFB"
- glib:nick="rtpfb">
- <doc xml:space="preserve">Transport layer feedback.</doc>
- </member>
- <member name="psfb"
- value="206"
- c:identifier="GST_RTCP_TYPE_PSFB"
- glib:nick="psfb">
- <doc xml:space="preserve">Payload-specific feedback.</doc>
- </member>
- </enumeration>
- <constant name="RTCP_MAX_BYE_SSRC_COUNT"
- value="31"
- c:type="GST_RTCP_MAX_BYE_SSRC_COUNT">
- <doc xml:space="preserve">The maximum amount of SSRCs in a BYE packet.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_MAX_RB_COUNT"
- value="31"
- c:type="GST_RTCP_MAX_RB_COUNT">
- <doc xml:space="preserve">The maximum amount of Receiver report blocks in RR and SR messages.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_MAX_SDES" value="255" c:type="GST_RTCP_MAX_SDES">
- <doc xml:space="preserve">The maximum text length for an SDES item.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_MAX_SDES_ITEM_COUNT"
- value="31"
- c:type="GST_RTCP_MAX_SDES_ITEM_COUNT">
- <doc xml:space="preserve">The maximum amount of SDES items.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_REDUCED_SIZE_VALID_MASK"
- value="57592"
- c:type="GST_RTCP_REDUCED_SIZE_VALID_MASK">
- <doc xml:space="preserve">Mask for version, padding bit and packet type pair allowing reduced size
- packets, basically it accepts other types than RR and SR</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_VALID_MASK"
- value="57598"
- c:type="GST_RTCP_VALID_MASK">
- <doc xml:space="preserve">Mask for version, padding bit and packet type pair</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_VALID_VALUE" value="0" c:type="GST_RTCP_VALID_VALUE">
- <doc xml:space="preserve">Valid value for the first two bytes of an RTCP packet after applying
- #GST_RTCP_VALID_MASK to them.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTCP_VERSION" value="2" c:type="GST_RTCP_VERSION">
- <doc xml:space="preserve">The supported RTCP version 2.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <class name="RTPBaseAudioPayload"
- c:symbol-prefix="rtp_base_audio_payload"
- c:type="GstRTPBaseAudioPayload"
- parent="RTPBasePayload"
- glib:type-name="GstRTPBaseAudioPayload"
- glib:get-type="gst_rtp_base_audio_payload_get_type"
- glib:type-struct="RTPBaseAudioPayloadClass">
- <doc xml:space="preserve">Provides a base class for audio RTP payloaders for frame or sample based
- audio codecs (constant bitrate)
- This class derives from GstRTPBasePayload. It can be used for payloading
- audio codecs. It will only work with constant bitrate codecs. It supports
- both frame based and sample based codecs. It takes care of packing up the
- audio data into RTP packets and filling up the headers accordingly. The
- payloading is done based on the maximum MTU (mtu) and the maximum time per
- packet (max-ptime). The general idea is to divide large data buffers into
- smaller RTP packets. The RTP packet size is the minimum of either the MTU,
- max-ptime (if set) or available data. The RTP packet size is always larger or
- equal to min-ptime (if set). If min-ptime is not set, any residual data is
- sent in a last RTP packet. In the case of frame based codecs, the resulting
- RTP packets always contain full frames.
- <refsect2>
- <title>Usage</title>
- <para>
- To use this base class, your child element needs to call either
- gst_rtp_base_audio_payload_set_frame_based() or
- gst_rtp_base_audio_payload_set_sample_based(). This is usually done in the
- element's _init() function. Then, the child element must call either
- gst_rtp_base_audio_payload_set_frame_options(),
- gst_rtp_base_audio_payload_set_sample_options() or
- gst_rtp_base_audio_payload_set_samplebits_options. Since
- GstRTPBaseAudioPayload derives from GstRTPBasePayload, the child element
- must set any variables or call/override any functions required by that base
- class. The child element does not need to override any other functions
- specific to GstRTPBaseAudioPayload.
- </para>
- </refsect2></doc>
- <method name="flush" c:identifier="gst_rtp_base_audio_payload_flush">
- <doc xml:space="preserve">Create an RTP buffer and store @payload_len bytes of the adapter as the
- payload. Set the timestamp on the new buffer to @timestamp before pushing
- the buffer downstream.
- If @payload_len is -1, all pending bytes will be flushed. If @timestamp is
- -1, the timestamp will be calculated automatically.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a #GstFlowReturn</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="baseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBasePayload</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve">length of payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve">a #GstClockTime</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_adapter"
- c:identifier="gst_rtp_base_audio_payload_get_adapter">
- <doc xml:space="preserve">Gets the internal adapter used by the depayloader.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">a #GstAdapter.</doc>
- <type name="GstBase.Adapter" c:type="GstAdapter*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBaseAudioPayload</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="push" c:identifier="gst_rtp_base_audio_payload_push">
- <doc xml:space="preserve">Create an RTP buffer and store @payload_len bytes of @data as the
- payload. Set the timestamp on the new buffer to @timestamp before pushing
- the buffer downstream.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a #GstFlowReturn</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="baseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBasePayload</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">data to set as payload</doc>
- <type name="guint8" c:type="const guint8*"/>
- </parameter>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve">length of payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve">a #GstClockTime</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_frame_based"
- c:identifier="gst_rtp_base_audio_payload_set_frame_based">
- <doc xml:space="preserve">Tells #GstRTPBaseAudioPayload that the child element is for a frame based
- audio codec</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve">a pointer to the element.</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_frame_options"
- c:identifier="gst_rtp_base_audio_payload_set_frame_options">
- <doc xml:space="preserve">Sets the options for frame based audio codecs.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve">a pointer to the element.</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- <parameter name="frame_duration" transfer-ownership="none">
- <doc xml:space="preserve">The duraction of an audio frame in milliseconds.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- <parameter name="frame_size" transfer-ownership="none">
- <doc xml:space="preserve">The size of an audio frame in bytes.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_sample_based"
- c:identifier="gst_rtp_base_audio_payload_set_sample_based">
- <doc xml:space="preserve">Tells #GstRTPBaseAudioPayload that the child element is for a sample based
- audio codec</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve">a pointer to the element.</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="set_sample_options"
- c:identifier="gst_rtp_base_audio_payload_set_sample_options">
- <doc xml:space="preserve">Sets the options for sample based audio codecs.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve">a pointer to the element.</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- <parameter name="sample_size" transfer-ownership="none">
- <doc xml:space="preserve">Size per sample in bytes.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_samplebits_options"
- c:identifier="gst_rtp_base_audio_payload_set_samplebits_options">
- <doc xml:space="preserve">Sets the options for sample based audio codecs.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtpbaseaudiopayload"
- transfer-ownership="none">
- <doc xml:space="preserve">a pointer to the element.</doc>
- <type name="RTPBaseAudioPayload" c:type="GstRTPBaseAudioPayload*"/>
- </instance-parameter>
- <parameter name="sample_size" transfer-ownership="none">
- <doc xml:space="preserve">Size per sample in bits.</doc>
- <type name="gint" c:type="gint"/>
- </parameter>
- </parameters>
- </method>
- <property name="buffer-list" writable="1" transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <field name="payload">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload"/>
- </field>
- <field name="priv">
- <type name="RTPBaseAudioPayloadPrivate"
- c:type="GstRTPBaseAudioPayloadPrivate*"/>
- </field>
- <field name="base_ts">
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </field>
- <field name="frame_size">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="frame_duration">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="sample_size">
- <type name="gint" c:type="gint"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" c:type="gpointer" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="RTPBaseAudioPayloadClass"
- c:type="GstRTPBaseAudioPayloadClass"
- glib:is-gtype-struct-for="RTPBaseAudioPayload">
- <doc xml:space="preserve">Base class for audio RTP payloader.</doc>
- <field name="parent_class">
- <doc xml:space="preserve">the parent class</doc>
- <type name="RTPBasePayloadClass" c:type="GstRTPBasePayloadClass"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" c:type="gpointer" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="RTPBaseAudioPayloadPrivate"
- c:type="GstRTPBaseAudioPayloadPrivate"
- disguised="1">
- </record>
- <class name="RTPBaseDepayload"
- c:symbol-prefix="rtp_base_depayload"
- c:type="GstRTPBaseDepayload"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstRTPBaseDepayload"
- glib:get-type="gst_rtp_base_depayload_get_type"
- glib:type-struct="RTPBaseDepayloadClass">
- <doc xml:space="preserve">Provides a base class for RTP depayloaders</doc>
- <virtual-method name="handle_event">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="packet_lost">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="process">
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="base" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="in" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="process_rtp_packet">
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="base" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="rtp_buffer" transfer-ownership="none">
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_caps">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="push" c:identifier="gst_rtp_base_depayload_push">
- <doc xml:space="preserve">Push @out_buf to the peer of @filter. This function takes ownership of
- @out_buf.
- This function will by default apply the last incomming timestamp on
- the outgoing buffer when it didn't have a timestamp already.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a #GstFlowReturn.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBaseDepayload</doc>
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="out_buf" transfer-ownership="none">
- <doc xml:space="preserve">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="push_list" c:identifier="gst_rtp_base_depayload_push_list">
- <doc xml:space="preserve">Push @out_list to the peer of @filter. This function takes ownership of
- @out_list.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a #GstFlowReturn.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="filter" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBaseDepayload</doc>
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </instance-parameter>
- <parameter name="out_list" transfer-ownership="none">
- <doc xml:space="preserve">a #GstBufferList</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </method>
- <property name="stats" transfer-ownership="none">
- <doc xml:space="preserve">Various depayloader statistics retrieved atomically (and are therefore
- synchroized with each other). This property return a GstStructure named
- application/x-rtp-depayload-stats containing the following fields relating to
- the last processed buffer and current state of the stream being depayloaded:
- <variablelist>
- <varlistentry>
- <term>clock-rate</term>
- <listitem><para>#G_TYPE_UINT, clock-rate of the
- stream</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>npt-start</term>
- <listitem><para>#G_TYPE_UINT64, time of playback start
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>npt-stop</term>
- <listitem><para>#G_TYPE_UINT64, time of playback stop
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>play-speed</term>
- <listitem><para>#G_TYPE_DOUBLE, the playback speed
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>play-scale</term>
- <listitem><para>#G_TYPE_DOUBLE, the playback scale
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>running-time-dts</term>
- <listitem><para>#G_TYPE_UINT64, the last running-time of the
- last DTS
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>running-time-pts</term>
- <listitem><para>#G_TYPE_UINT64, the last running-time of the
- last PTS
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>seqnum</term>
- <listitem><para>#G_TYPE_UINT, the last seen seqnum
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>timestamp</term>
- <listitem><para>#G_TYPE_UINT, the last seen RTP timestamp
- </para></listitem>
- </varlistentry>
- </variablelist></doc>
- <type name="Gst.Structure"/>
- </property>
- <field name="parent">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="sinkpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="srcpad">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="clock_rate">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="segment">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="need_newsegment">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="RTPBaseDepayloadPrivate"
- c:type="GstRTPBaseDepayloadPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" c:type="gpointer" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="RTPBaseDepayloadClass"
- c:type="GstRTPBaseDepayloadClass"
- glib:is-gtype-struct-for="RTPBaseDepayload">
- <doc xml:space="preserve">Base class for audio RTP payloader.</doc>
- <field name="parent_class">
- <doc xml:space="preserve">the parent class</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="set_caps">
- <callback name="set_caps">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="process">
- <callback name="process">
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="base" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </parameter>
- <parameter name="in" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="packet_lost">
- <callback name="packet_lost">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="handle_event">
- <callback name="handle_event">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="filter" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="process_rtp_packet">
- <callback name="process_rtp_packet">
- <return-value transfer-ownership="full">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="base" transfer-ownership="none">
- <type name="RTPBaseDepayload" c:type="GstRTPBaseDepayload*"/>
- </parameter>
- <parameter name="rtp_buffer" transfer-ownership="none">
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" c:type="gpointer" fixed-size="3">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="RTPBaseDepayloadPrivate"
- c:type="GstRTPBaseDepayloadPrivate"
- disguised="1">
- </record>
- <class name="RTPBasePayload"
- c:symbol-prefix="rtp_base_payload"
- c:type="GstRTPBasePayload"
- parent="Gst.Element"
- abstract="1"
- glib:type-name="GstRTPBasePayload"
- glib:get-type="gst_rtp_base_payload_get_type"
- glib:type-struct="RTPBasePayloadClass">
- <doc xml:space="preserve">Provides a base class for RTP payloaders</doc>
- <virtual-method name="get_caps">
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="handle_buffer">
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="query">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="set_caps">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="sink_event">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <virtual-method name="src_event">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </virtual-method>
- <method name="is_filled" c:identifier="gst_rtp_base_payload_is_filled">
- <doc xml:space="preserve">Check if the packet with @size and @duration would exceed the configured
- maximum size.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the packet of @size and @duration would exceed the
- configured MTU or max_ptime.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve">the size of the packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="duration" transfer-ownership="none">
- <doc xml:space="preserve">the duration of the packet</doc>
- <type name="Gst.ClockTime" c:type="GstClockTime"/>
- </parameter>
- </parameters>
- </method>
- <method name="push" c:identifier="gst_rtp_base_payload_push">
- <doc xml:space="preserve">Push @buffer to the peer element of the payloader. The SSRC, payload type,
- seqnum and timestamp of the RTP buffer will be updated first.
- This function takes ownership of @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a #GstFlowReturn.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </method>
- <method name="push_list" c:identifier="gst_rtp_base_payload_push_list">
- <doc xml:space="preserve">Push @list to the peer element of the payloader. The SSRC, payload type,
- seqnum and timestamp of the RTP buffer will be updated first.
- This function takes ownership of @list.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a #GstFlowReturn.</doc>
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="list" transfer-ownership="none">
- <doc xml:space="preserve">a #GstBufferList</doc>
- <type name="Gst.BufferList" c:type="GstBufferList*"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_options"
- c:identifier="gst_rtp_base_payload_set_options">
- <doc xml:space="preserve">Set the rtp options of the payloader. These options will be set in the caps
- of the payloader. Subclasses must call this method before calling
- gst_rtp_base_payload_push() or gst_rtp_base_payload_set_outcaps().</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve">the media type (typically "audio" or "video")</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="dynamic" transfer-ownership="none">
- <doc xml:space="preserve">if the payload type is dynamic</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- <parameter name="encoding_name" transfer-ownership="none">
- <doc xml:space="preserve">the encoding name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="clock_rate" transfer-ownership="none">
- <doc xml:space="preserve">the clock rate of the media</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_outcaps"
- c:identifier="gst_rtp_base_payload_set_outcaps"
- introspectable="0">
- <doc xml:space="preserve">Configure the output caps with the optional parameters.
- Variable arguments should be in the form field name, field type
- (as a GType), value(s). The last variable argument should be NULL.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if the caps could be set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="payload" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBasePayload</doc>
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </instance-parameter>
- <parameter name="fieldname" transfer-ownership="none">
- <doc xml:space="preserve">the first field name or %NULL</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="..." transfer-ownership="none">
- <doc xml:space="preserve">field values</doc>
- <varargs/>
- </parameter>
- </parameters>
- </method>
- <property name="max-ptime" writable="1" transfer-ownership="none">
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="min-ptime" writable="1" transfer-ownership="none">
- <doc xml:space="preserve">Minimum duration of the packet data in ns (can't go above MTU)</doc>
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="mtu" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="perfect-rtptime" writable="1" transfer-ownership="none">
- <doc xml:space="preserve">Try to use the offset fields to generate perfect RTP timestamps. When this
- option is disabled, RTP timestamps are generated from GST_BUFFER_PTS of
- each payloaded buffer. The PTSes of buffers may not necessarily increment
- with the amount of data in each input buffer, consider e.g. the case where
- the buffer arrives from a network which means that the PTS is unrelated to
- the amount of data. Because the RTP timestamps are generated from
- GST_BUFFER_PTS this can result in RTP timestamps that also don't increment
- with the amount of data in the payloaded packet. To circumvent this it is
- possible to set the perfect rtptime option enabled. When this option is
- enabled the payloader will increment the RTP timestamps based on
- GST_BUFFER_OFFSET which relates to the amount of data in each packet
- rather than the GST_BUFFER_PTS of each buffer and therefore the RTP
- timestamps will more closely correlate with the amount of data in each
- buffer. Currently GstRTPBasePayload is limited to handling perfect RTP
- timestamps for audio streams.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </property>
- <property name="pt" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="ptime-multiple" writable="1" transfer-ownership="none">
- <doc xml:space="preserve">Force buffers to be multiples of this duration in ns (0 disables)</doc>
- <type name="gint64" c:type="gint64"/>
- </property>
- <property name="seqnum" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="seqnum-offset" writable="1" transfer-ownership="none">
- <type name="gint" c:type="gint"/>
- </property>
- <property name="ssrc" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="stats" transfer-ownership="none">
- <doc xml:space="preserve">Various payloader statistics retrieved atomically (and are therefore
- synchroized with each other), these can be used e.g. to generate an
- RTP-Info header. This property return a GstStructure named
- application/x-rtp-payload-stats containing the following fields relating to
- the last processed buffer and current state of the stream being payloaded:
- <variablelist>
- <varlistentry>
- <term>clock-rate</term>
- <listitem><para>#G_TYPE_UINT, clock-rate of the
- stream</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>running-time</term>
- <listitem><para>#G_TYPE_UINT64, running time
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>seqnum</term>
- <listitem><para>#G_TYPE_UINT, sequence number, same as
- #GstRTPBasePayload:seqnum</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>timestamp</term>
- <listitem><para>#G_TYPE_UINT, RTP timestamp, same as
- #GstRTPBasePayload:timestamp</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>ssrc</term>
- <listitem><para>#G_TYPE_UINT, The SSRC in use
- </para></listitem>
- </varlistentry>
- <varlistentry>
- <term>pt</term>
- <listitem><para>#G_TYPE_UINT, The Payload type in use, same as
- #GstRTPBasePayload:pt</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>seqnum-offset</term>
- <listitem><para>#G_TYPE_UINT, The current offset added to the
- seqnum</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>timestamp-offset</term>
- <listitem><para>#G_TYPE_UINT, The current offset added to the
- timestamp</para></listitem>
- </varlistentry>
- </variablelist></doc>
- <type name="Gst.Structure"/>
- </property>
- <property name="timestamp" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <property name="timestamp-offset" writable="1" transfer-ownership="none">
- <type name="guint" c:type="guint"/>
- </property>
- <field name="element">
- <type name="Gst.Element" c:type="GstElement"/>
- </field>
- <field name="sinkpad" readable="0" private="1">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="srcpad" readable="0" private="1">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </field>
- <field name="ts_base" readable="0" private="1">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="seqnum_base" readable="0" private="1">
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="media" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="encoding_name" readable="0" private="1">
- <type name="utf8" c:type="gchar*"/>
- </field>
- <field name="dynamic" readable="0" private="1">
- <type name="gboolean" c:type="gboolean"/>
- </field>
- <field name="clock_rate" readable="0" private="1">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="ts_offset" readable="0" private="1">
- <type name="gint32" c:type="gint32"/>
- </field>
- <field name="timestamp" readable="0" private="1">
- <type name="guint32" c:type="guint32"/>
- </field>
- <field name="seqnum_offset" readable="0" private="1">
- <type name="gint16" c:type="gint16"/>
- </field>
- <field name="seqnum" readable="0" private="1">
- <type name="guint16" c:type="guint16"/>
- </field>
- <field name="max_ptime" readable="0" private="1">
- <type name="gint64" c:type="gint64"/>
- </field>
- <field name="pt" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="ssrc" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="current_ssrc" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="mtu" readable="0" private="1">
- <type name="guint" c:type="guint"/>
- </field>
- <field name="segment" readable="0" private="1">
- <type name="Gst.Segment" c:type="GstSegment"/>
- </field>
- <field name="min_ptime" readable="0" private="1">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="ptime" readable="0" private="1">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="ptime_multiple" readable="0" private="1">
- <type name="guint64" c:type="guint64"/>
- </field>
- <field name="priv" readable="0" private="1">
- <type name="RTPBasePayloadPrivate" c:type="GstRTPBasePayloadPrivate*"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" c:type="gpointer" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </class>
- <record name="RTPBasePayloadClass"
- c:type="GstRTPBasePayloadClass"
- glib:is-gtype-struct-for="RTPBasePayload">
- <doc xml:space="preserve">Base class for audio RTP payloader.</doc>
- <field name="parent_class">
- <doc xml:space="preserve">the parent class</doc>
- <type name="Gst.ElementClass" c:type="GstElementClass"/>
- </field>
- <field name="get_caps">
- <callback name="get_caps">
- <return-value transfer-ownership="full">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="filter" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="set_caps">
- <callback name="set_caps">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="caps" transfer-ownership="none">
- <type name="Gst.Caps" c:type="GstCaps*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="handle_buffer">
- <callback name="handle_buffer">
- <return-value transfer-ownership="none">
- <type name="Gst.FlowReturn" c:type="GstFlowReturn"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="buffer" transfer-ownership="none">
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="sink_event">
- <callback name="sink_event">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="src_event">
- <callback name="src_event">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="event" transfer-ownership="none">
- <type name="Gst.Event" c:type="GstEvent*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="query">
- <callback name="query">
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="payload" transfer-ownership="none">
- <type name="RTPBasePayload" c:type="GstRTPBasePayload*"/>
- </parameter>
- <parameter name="pad" transfer-ownership="none">
- <type name="Gst.Pad" c:type="GstPad*"/>
- </parameter>
- <parameter name="query" transfer-ownership="none">
- <type name="Gst.Query" c:type="GstQuery*"/>
- </parameter>
- </parameters>
- </callback>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" c:type="gpointer" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- </record>
- <record name="RTPBasePayloadPrivate"
- c:type="GstRTPBasePayloadPrivate"
- disguised="1">
- </record>
- <record name="RTPBuffer" c:type="GstRTPBuffer">
- <doc xml:space="preserve"><refsect2>
- <para>
- The GstRTPBuffer helper functions makes it easy to parse and create regular
- #GstBuffer objects that contain RTP payloads. These buffers are typically of
- 'application/x-rtp' #GstCaps.
- </para>
- </refsect2></doc>
- <field name="buffer" writable="1">
- <doc xml:space="preserve">pointer to RTP buffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </field>
- <field name="state" writable="1">
- <doc xml:space="preserve">internal state</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="data" writable="1">
- <doc xml:space="preserve">array of data</doc>
- <array zero-terminated="0" c:type="gpointer" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <field name="size" writable="1">
- <doc xml:space="preserve">array of size</doc>
- <array zero-terminated="0" c:type="gsize" fixed-size="4">
- <type name="gsize" c:type="gsize"/>
- </array>
- </field>
- <field name="map" writable="1">
- <doc xml:space="preserve">array of #GstMapInfo</doc>
- <array zero-terminated="0" c:type="GstMapInfo" fixed-size="4">
- <type name="Gst.MapInfo" c:type="GstMapInfo"/>
- </array>
- </field>
- <method name="add_extension_onebyte_header"
- c:identifier="gst_rtp_buffer_add_extension_onebyte_header">
- <doc xml:space="preserve">Adds a RFC 5285 header extension with a one byte header to the end of the
- RTP header. If there is already a RFC 5285 header extension with a one byte
- header, the new extension will be appended.
- It will not work if there is already a header extension that does not follow
- the mecanism described in RFC 5285 or if there is a header extension with
- a two bytes header as described in RFC 5285. In that case, use
- gst_rtp_buffer_add_extension_twobytes_header()</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if header extension could be added</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve">The ID of the header extension (between 1 and 14).</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">location for data</doc>
- <array length="2" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve">the size of the data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="add_extension_twobytes_header"
- c:identifier="gst_rtp_buffer_add_extension_twobytes_header">
- <doc xml:space="preserve">Adds a RFC 5285 header extension with a two bytes header to the end of the
- RTP header. If there is already a RFC 5285 header extension with a two bytes
- header, the new extension will be appended.
- It will not work if there is already a header extension that does not follow
- the mecanism described in RFC 5285 or if there is a header extension with
- a one byte header as described in RFC 5285. In that case, use
- gst_rtp_buffer_add_extension_onebyte_header()</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if header extension could be added</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="appbits" transfer-ownership="none">
- <doc xml:space="preserve">Application specific bits</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve">The ID of the header extension</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">location for data</doc>
- <array length="3" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve">the size of the data in bytes</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_csrc" c:identifier="gst_rtp_buffer_get_csrc">
- <doc xml:space="preserve">Get the CSRC at index @idx in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the CSRC at index @idx in host order.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve">the index of the CSRC to get</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_csrc_count"
- c:identifier="gst_rtp_buffer_get_csrc_count">
- <doc xml:space="preserve">Get the CSRC count of the RTP packet in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the CSRC count of @buffer.</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_extension" c:identifier="gst_rtp_buffer_get_extension">
- <doc xml:space="preserve">Check if the extension bit is set on the RTP packet in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @buffer has the extension bit set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_extension_bytes"
- c:identifier="gst_rtp_buffer_get_extension_bytes"
- shadows="get_extension_data"
- version="1.2">
- <doc xml:space="preserve">Similar to gst_rtp_buffer_get_extension_data, but more suitable for language
- bindings usage. @bits will contain the extension 16 bits of custom data and
- the extension data (not including the extension header) is placed in a new
- #GBytes structure.
- If @rtp did not contain an extension, this function will return %NULL, with
- @bits unchanged. If there is an extension header but no extension data then
- an empty #GBytes will be returned.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A new #GBytes if an extension header was present
- and %NULL otherwise.</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="bits"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">location for header bits</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_extension_data"
- c:identifier="gst_rtp_buffer_get_extension_data"
- shadowed-by="get_extension_bytes"
- introspectable="0">
- <doc xml:space="preserve">Get the extension data. @bits will contain the extension 16 bits of custom
- data. @data will point to the data in the extension and @wordlen will contain
- the length of @data in 32 bits words.
- If @buffer did not contain an extension, this function will return %FALSE
- with @bits, @data and @wordlen unchanged.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @buffer had the extension bit set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="bits"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">location for result bits</doc>
- <type name="guint16" c:type="guint16*"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve">location for data</doc>
- <array zero-terminated="0" c:type="gpointer*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="wordlen"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">location for length of @data in 32 bits words</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_extension_onebyte_header"
- c:identifier="gst_rtp_buffer_get_extension_onebyte_header">
- <doc xml:space="preserve">Parses RFC 5285 style header extensions with a one byte header. It will
- return the nth extension with the requested id.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @buffer had the requested header extension</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve">The ID of the header extension to be read (between 1 and 14).</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve">Read the nth extension packet with the requested ID</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve">
- location for data</doc>
- <array length="3" zero-terminated="0" c:type="gpointer*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">the size of the data in bytes</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_extension_twobytes_header"
- c:identifier="gst_rtp_buffer_get_extension_twobytes_header">
- <doc xml:space="preserve">Parses RFC 5285 style header extensions with a two bytes header. It will
- return the nth extension with the requested id.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @buffer had the requested header extension</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="appbits"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">Application specific bits</doc>
- <type name="guint8" c:type="guint8*"/>
- </parameter>
- <parameter name="id" transfer-ownership="none">
- <doc xml:space="preserve">The ID of the header extension to be read (between 1 and 14).</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="nth" transfer-ownership="none">
- <doc xml:space="preserve">Read the nth extension packet with the requested ID</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="data"
- direction="out"
- caller-allocates="0"
- transfer-ownership="none">
- <doc xml:space="preserve">
- location for data</doc>
- <array length="4" zero-terminated="0" c:type="gpointer*">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="size"
- direction="out"
- caller-allocates="0"
- transfer-ownership="full">
- <doc xml:space="preserve">the size of the data in bytes</doc>
- <type name="guint" c:type="guint*"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_header_len"
- c:identifier="gst_rtp_buffer_get_header_len">
- <doc xml:space="preserve">Return the total length of the header in @buffer. This include the length of
- the fixed header, the CSRC list and the extension header.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The total length of the header in @buffer.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_marker" c:identifier="gst_rtp_buffer_get_marker">
- <doc xml:space="preserve">Check if the marker bit is set on the RTP packet in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @buffer has the marker bit set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_packet_len"
- c:identifier="gst_rtp_buffer_get_packet_len">
- <doc xml:space="preserve">Return the total length of the packet in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The total length of the packet in @buffer.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_padding" c:identifier="gst_rtp_buffer_get_padding">
- <doc xml:space="preserve">Check if the padding bit is set on the RTP packet in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @buffer has the padding bit set.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_payload"
- c:identifier="gst_rtp_buffer_get_payload"
- shadowed-by="get_payload_bytes"
- introspectable="0">
- <doc xml:space="preserve">Get a pointer to the payload data in @buffer. This pointer is valid as long
- as a reference to @buffer is held.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">A pointer
- to the payload data in @buffer.</doc>
- <array zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_payload_buffer"
- c:identifier="gst_rtp_buffer_get_payload_buffer">
- <doc xml:space="preserve">Create a buffer of the payload of the RTP packet in @buffer. This function
- will internally create a subbuffer of @buffer so that a memcpy can be
- avoided.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A new buffer with the data of the payload.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_payload_bytes"
- c:identifier="gst_rtp_buffer_get_payload_bytes"
- shadows="get_payload"
- version="1.2">
- <doc xml:space="preserve">Similar to gst_rtp_buffer_get_payload, but more suitable for language
- bindings usage. The return value is a pointer to a #GBytes structure
- containing the payload data in @rtp.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A new #GBytes containing the payload data in @rtp.</doc>
- <type name="GLib.Bytes" c:type="GBytes*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_payload_len"
- c:identifier="gst_rtp_buffer_get_payload_len">
- <doc xml:space="preserve">Get the length of the payload of the RTP packet in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The length of the payload in @buffer.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_payload_subbuffer"
- c:identifier="gst_rtp_buffer_get_payload_subbuffer">
- <doc xml:space="preserve">Create a subbuffer of the payload of the RTP packet in @buffer. @offset bytes
- are skipped in the payload and the subbuffer will be of size @len.
- If @len is -1 the total payload starting from @offset is subbuffered.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A new buffer with the specified data of the payload.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="offset" transfer-ownership="none">
- <doc xml:space="preserve">the offset in the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length in the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="get_payload_type"
- c:identifier="gst_rtp_buffer_get_payload_type">
- <doc xml:space="preserve">Get the payload type of the RTP packet in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The payload type.</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_seq" c:identifier="gst_rtp_buffer_get_seq">
- <doc xml:space="preserve">Get the sequence number of the RTP packet in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The sequence number in host order.</doc>
- <type name="guint16" c:type="guint16"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_ssrc" c:identifier="gst_rtp_buffer_get_ssrc">
- <doc xml:space="preserve">Get the SSRC of the RTP packet in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the SSRC of @buffer in host order.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_timestamp" c:identifier="gst_rtp_buffer_get_timestamp">
- <doc xml:space="preserve">Get the timestamp of the RTP packet in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The timestamp in host order.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="get_version" c:identifier="gst_rtp_buffer_get_version">
- <doc xml:space="preserve">Get the version number of the RTP packet in @buffer.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The version of @buffer.</doc>
- <type name="guint8" c:type="guint8"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <method name="pad_to" c:identifier="gst_rtp_buffer_pad_to">
- <doc xml:space="preserve">Set the amount of padding in the RTP packet in @buffer to
- @len. If @len is 0, the padding is removed.
- NOTE: This function does not work correctly.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the new amount of padding</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_csrc" c:identifier="gst_rtp_buffer_set_csrc">
- <doc xml:space="preserve">Modify the CSRC at index @idx in @buffer to @csrc.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="idx" transfer-ownership="none">
- <doc xml:space="preserve">the CSRC index to set</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc" transfer-ownership="none">
- <doc xml:space="preserve">the CSRC in host order to set at @idx</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_extension" c:identifier="gst_rtp_buffer_set_extension">
- <doc xml:space="preserve">Set the extension bit on the RTP packet in @buffer to @extension.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="extension" transfer-ownership="none">
- <doc xml:space="preserve">the new extension</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_extension_data"
- c:identifier="gst_rtp_buffer_set_extension_data">
- <doc xml:space="preserve">Set the extension bit of the rtp buffer and fill in the @bits and @length of the
- extension header. If the existing extension data is not large enough, it will
- be made larger.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">True if done.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="bits" transfer-ownership="none">
- <doc xml:space="preserve">the bits specific for the extension</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="length" transfer-ownership="none">
- <doc xml:space="preserve">the length that counts the number of 32-bit words in
- the extension, excluding the extension header ( therefore zero is a valid length)</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_marker" c:identifier="gst_rtp_buffer_set_marker">
- <doc xml:space="preserve">Set the marker bit on the RTP packet in @buffer to @marker.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="marker" transfer-ownership="none">
- <doc xml:space="preserve">the new marker</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_packet_len"
- c:identifier="gst_rtp_buffer_set_packet_len">
- <doc xml:space="preserve">Set the total @rtp size to @len. The data in the buffer will be made
- larger if needed. Any padding will be removed from the packet.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the new packet length</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_padding" c:identifier="gst_rtp_buffer_set_padding">
- <doc xml:space="preserve">Set the padding bit on the RTP packet in @buffer to @padding.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the buffer</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="padding" transfer-ownership="none">
- <doc xml:space="preserve">the new padding</doc>
- <type name="gboolean" c:type="gboolean"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_payload_type"
- c:identifier="gst_rtp_buffer_set_payload_type">
- <doc xml:space="preserve">Set the payload type of the RTP packet in @buffer to @payload_type.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="payload_type" transfer-ownership="none">
- <doc xml:space="preserve">the new type</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_seq" c:identifier="gst_rtp_buffer_set_seq">
- <doc xml:space="preserve">Set the sequence number of the RTP packet in @buffer to @seq.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="seq" transfer-ownership="none">
- <doc xml:space="preserve">the new sequence number</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_ssrc" c:identifier="gst_rtp_buffer_set_ssrc">
- <doc xml:space="preserve">Set the SSRC on the RTP packet in @buffer to @ssrc.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="ssrc" transfer-ownership="none">
- <doc xml:space="preserve">the new SSRC</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_timestamp" c:identifier="gst_rtp_buffer_set_timestamp">
- <doc xml:space="preserve">Set the timestamp of the RTP packet in @buffer to @timestamp.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve">the new timestamp</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </method>
- <method name="set_version" c:identifier="gst_rtp_buffer_set_version">
- <doc xml:space="preserve">Set the version of the RTP packet in @buffer to @version.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">the RTP packet</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- <parameter name="version" transfer-ownership="none">
- <doc xml:space="preserve">the new version</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </method>
- <method name="unmap" c:identifier="gst_rtp_buffer_unmap">
- <doc xml:space="preserve">Unmap @rtp previously mapped with gst_rtp_buffer_map().</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <instance-parameter name="rtp" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBuffer</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </instance-parameter>
- </parameters>
- </method>
- <function name="allocate_data"
- c:identifier="gst_rtp_buffer_allocate_data">
- <doc xml:space="preserve">Allocate enough data in @buffer to hold an RTP packet with @csrc_count CSRCs,
- a payload length of @payload_len and padding of @pad_len.
- @buffer must be writable and all previous memory in @buffer will be freed.
- If @pad_len is >0, the padding bit will be set. All other RTP header fields
- will be set to 0/FALSE.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="calc_header_len"
- c:identifier="gst_rtp_buffer_calc_header_len">
- <doc xml:space="preserve">Calculate the header length of an RTP packet with @csrc_count CSRC entries.
- An RTP packet can have at most 15 CSRC entries.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The length of an RTP header with @csrc_count CSRC entries.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="calc_packet_len"
- c:identifier="gst_rtp_buffer_calc_packet_len">
- <doc xml:space="preserve">Calculate the total length of an RTP packet with a payload size of @payload_len,
- a padding of @pad_len and a @csrc_count CSRC entries.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The total length of an RTP header with given parameters.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="calc_payload_len"
- c:identifier="gst_rtp_buffer_calc_payload_len">
- <doc xml:space="preserve">Calculate the length of the payload of an RTP packet with size @packet_len,
- a padding of @pad_len and a @csrc_count CSRC entries.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The length of the payload of an RTP packet with given parameters.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="packet_len" transfer-ownership="none">
- <doc xml:space="preserve">the length of the total RTP packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="compare_seqnum"
- c:identifier="gst_rtp_buffer_compare_seqnum">
- <doc xml:space="preserve">Compare two sequence numbers, taking care of wraparounds. This function
- returns the difference between @seqnum1 and @seqnum2.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a negative value if @seqnum1 is bigger than @seqnum2, 0 if they
- are equal or a positive value if @seqnum1 is smaller than @segnum2.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="seqnum1" transfer-ownership="none">
- <doc xml:space="preserve">a sequence number</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="seqnum2" transfer-ownership="none">
- <doc xml:space="preserve">a sequence number</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </function>
- <function name="default_clock_rate"
- c:identifier="gst_rtp_buffer_default_clock_rate">
- <doc xml:space="preserve">Get the default clock-rate for the static payload type @payload_type.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the default clock rate or -1 if the payload type is not static or
- the clock-rate is undefined.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <parameter name="payload_type" transfer-ownership="none">
- <doc xml:space="preserve">the static payload type</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="ext_timestamp"
- c:identifier="gst_rtp_buffer_ext_timestamp">
- <doc xml:space="preserve">Update the @exttimestamp field with @timestamp. For the first call of the
- method, @exttimestamp should point to a location with a value of -1.
- This function makes sure that the returned value is a constantly increasing
- value even in the case where there is a timestamp wraparound.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The extended timestamp of @timestamp.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="exttimestamp" transfer-ownership="none">
- <doc xml:space="preserve">a previous extended timestamp</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve">a new timestamp</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </function>
- <function name="map" c:identifier="gst_rtp_buffer_map">
- <doc xml:space="preserve">Map the contents of @buffer into @rtp.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if @buffer could be mapped.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve">#GstMapFlags</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- <parameter name="rtp"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBuffer</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_allocate" c:identifier="gst_rtp_buffer_new_allocate">
- <doc xml:space="preserve">Allocate a new #GstBuffer with enough data to hold an RTP packet with
- @csrc_count CSRCs, a payload length of @payload_len and padding of @pad_len.
- All other RTP header fields will be set to 0/FALSE.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer that can hold an RTP packet with given
- parameters.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_allocate_len"
- c:identifier="gst_rtp_buffer_new_allocate_len">
- <doc xml:space="preserve">Create a new #GstBuffer that can hold an RTP packet that is exactly
- @packet_len long. The length of the payload depends on @pad_len and
- @csrc_count and can be calculated with gst_rtp_buffer_calc_payload_len().
- All RTP header fields will be set to 0/FALSE.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer that can hold an RTP packet of @packet_len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="packet_len" transfer-ownership="none">
- <doc xml:space="preserve">the total length of the packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_copy_data"
- c:identifier="gst_rtp_buffer_new_copy_data">
- <doc xml:space="preserve">Create a new buffer and set the data to a copy of @len
- bytes of @data and the size to @len. The data will be freed when the buffer
- is freed.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer with a copy of @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">data for the new
- buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- <function name="new_take_data"
- c:identifier="gst_rtp_buffer_new_take_data">
- <doc xml:space="preserve">Create a new buffer and set the data and size of the buffer to @data and @len
- respectively. @data will be freed when the buffer is unreffed, so this
- function transfers ownership of @data to the new buffer.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer with @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="full">
- <doc xml:space="preserve">
- data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <bitfield name="RTPBufferMapFlags"
- version="1.6.1"
- glib:type-name="GstRTPBufferMapFlags"
- glib:get-type="gst_rtp_buffer_map_flags_get_type"
- c:type="GstRTPBufferMapFlags">
- <doc xml:space="preserve">Additional mapping flags for gst_rtp_buffer_map().</doc>
- <member name="skip_padding"
- value="65536"
- c:identifier="GST_RTP_BUFFER_MAP_FLAG_SKIP_PADDING"
- glib:nick="skip-padding">
- <doc xml:space="preserve">Skip mapping and validation of RTP
- padding and RTP pad count when present. Useful for buffers where
- the padding may be encrypted.</doc>
- </member>
- <member name="last"
- value="16777216"
- c:identifier="GST_RTP_BUFFER_MAP_FLAG_LAST"
- glib:nick="last">
- <doc xml:space="preserve">Offset to define more flags</doc>
- </member>
- </bitfield>
- <enumeration name="RTPPayload"
- glib:type-name="GstRTPPayload"
- glib:get-type="gst_rtp_payload_get_type"
- c:type="GstRTPPayload">
- <doc xml:space="preserve">Standard predefined fixed payload types.
- The official list is at:
- http://www.iana.org/assignments/rtp-parameters
- Audio:
- reserved: 19
- unassigned: 20-23,
- Video:
- unassigned: 24, 27, 29, 30, 35-71, 77-95
- Reserved for RTCP conflict avoidance: 72-76</doc>
- <member name="pcmu"
- value="0"
- c:identifier="GST_RTP_PAYLOAD_PCMU"
- glib:nick="pcmu">
- <doc xml:space="preserve">ITU-T G.711. mu-law audio (RFC 3551)</doc>
- </member>
- <member name="1016"
- value="1"
- c:identifier="GST_RTP_PAYLOAD_1016"
- glib:nick="1016">
- <doc xml:space="preserve">RFC 3551 says reserved</doc>
- </member>
- <member name="g721"
- value="2"
- c:identifier="GST_RTP_PAYLOAD_G721"
- glib:nick="g721">
- <doc xml:space="preserve">RFC 3551 says reserved</doc>
- </member>
- <member name="gsm"
- value="3"
- c:identifier="GST_RTP_PAYLOAD_GSM"
- glib:nick="gsm">
- <doc xml:space="preserve">GSM audio</doc>
- </member>
- <member name="g723"
- value="4"
- c:identifier="GST_RTP_PAYLOAD_G723"
- glib:nick="g723">
- <doc xml:space="preserve">ITU G.723.1 audio</doc>
- </member>
- <member name="dvi4_8000"
- value="5"
- c:identifier="GST_RTP_PAYLOAD_DVI4_8000"
- glib:nick="dvi4-8000">
- <doc xml:space="preserve">IMA ADPCM wave type (RFC 3551)</doc>
- </member>
- <member name="dvi4_16000"
- value="6"
- c:identifier="GST_RTP_PAYLOAD_DVI4_16000"
- glib:nick="dvi4-16000">
- <doc xml:space="preserve">IMA ADPCM wave type (RFC 3551)</doc>
- </member>
- <member name="lpc"
- value="7"
- c:identifier="GST_RTP_PAYLOAD_LPC"
- glib:nick="lpc">
- <doc xml:space="preserve">experimental linear predictive encoding</doc>
- </member>
- <member name="pcma"
- value="8"
- c:identifier="GST_RTP_PAYLOAD_PCMA"
- glib:nick="pcma">
- <doc xml:space="preserve">ITU-T G.711 A-law audio (RFC 3551)</doc>
- </member>
- <member name="g722"
- value="9"
- c:identifier="GST_RTP_PAYLOAD_G722"
- glib:nick="g722">
- <doc xml:space="preserve">ITU-T G.722 (RFC 3551)</doc>
- </member>
- <member name="l16_stereo"
- value="10"
- c:identifier="GST_RTP_PAYLOAD_L16_STEREO"
- glib:nick="l16-stereo">
- <doc xml:space="preserve">stereo PCM</doc>
- </member>
- <member name="l16_mono"
- value="11"
- c:identifier="GST_RTP_PAYLOAD_L16_MONO"
- glib:nick="l16-mono">
- <doc xml:space="preserve">mono PCM</doc>
- </member>
- <member name="qcelp"
- value="12"
- c:identifier="GST_RTP_PAYLOAD_QCELP"
- glib:nick="qcelp">
- <doc xml:space="preserve">EIA & TIA standard IS-733</doc>
- </member>
- <member name="cn"
- value="13"
- c:identifier="GST_RTP_PAYLOAD_CN"
- glib:nick="cn">
- <doc xml:space="preserve">Comfort Noise (RFC 3389)</doc>
- </member>
- <member name="mpa"
- value="14"
- c:identifier="GST_RTP_PAYLOAD_MPA"
- glib:nick="mpa">
- <doc xml:space="preserve">Audio MPEG 1-3.</doc>
- </member>
- <member name="g728"
- value="15"
- c:identifier="GST_RTP_PAYLOAD_G728"
- glib:nick="g728">
- <doc xml:space="preserve">ITU-T G.728 Speech coder (RFC 3551)</doc>
- </member>
- <member name="dvi4_11025"
- value="16"
- c:identifier="GST_RTP_PAYLOAD_DVI4_11025"
- glib:nick="dvi4-11025">
- <doc xml:space="preserve">IMA ADPCM wave type (RFC 3551)</doc>
- </member>
- <member name="dvi4_22050"
- value="17"
- c:identifier="GST_RTP_PAYLOAD_DVI4_22050"
- glib:nick="dvi4-22050">
- <doc xml:space="preserve">IMA ADPCM wave type (RFC 3551)</doc>
- </member>
- <member name="g729"
- value="18"
- c:identifier="GST_RTP_PAYLOAD_G729"
- glib:nick="g729">
- <doc xml:space="preserve">ITU-T G.729 Speech coder (RFC 3551)</doc>
- </member>
- <member name="cellb"
- value="25"
- c:identifier="GST_RTP_PAYLOAD_CELLB"
- glib:nick="cellb">
- <doc xml:space="preserve">See RFC 2029</doc>
- </member>
- <member name="jpeg"
- value="26"
- c:identifier="GST_RTP_PAYLOAD_JPEG"
- glib:nick="jpeg">
- <doc xml:space="preserve">ISO Standards 10918-1 and 10918-2 (RFC 2435)</doc>
- </member>
- <member name="nv"
- value="28"
- c:identifier="GST_RTP_PAYLOAD_NV"
- glib:nick="nv">
- <doc xml:space="preserve">nv encoding by Ron Frederick</doc>
- </member>
- <member name="h261"
- value="31"
- c:identifier="GST_RTP_PAYLOAD_H261"
- glib:nick="h261">
- <doc xml:space="preserve">ITU-T Recommendation H.261 (RFC 2032)</doc>
- </member>
- <member name="mpv"
- value="32"
- c:identifier="GST_RTP_PAYLOAD_MPV"
- glib:nick="mpv">
- <doc xml:space="preserve">Video MPEG 1 & 2 (RFC 2250)</doc>
- </member>
- <member name="mp2t"
- value="33"
- c:identifier="GST_RTP_PAYLOAD_MP2T"
- glib:nick="mp2t">
- <doc xml:space="preserve">MPEG-2 transport stream (RFC 2250)</doc>
- </member>
- <member name="h263"
- value="34"
- c:identifier="GST_RTP_PAYLOAD_H263"
- glib:nick="h263">
- <doc xml:space="preserve">Video H263 (RFC 2190)</doc>
- </member>
- </enumeration>
- <record name="RTPPayloadInfo" c:type="GstRTPPayloadInfo">
- <doc xml:space="preserve">Structure holding default payload type information.</doc>
- <field name="payload_type" writable="1">
- <doc xml:space="preserve">payload type, -1 means dynamic</doc>
- <type name="guint8" c:type="guint8"/>
- </field>
- <field name="media" writable="1">
- <doc xml:space="preserve">the media type(s), usually "audio", "video", "application", "text",
- "message".</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="encoding_name" writable="1">
- <doc xml:space="preserve">the encoding name of @pt</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="clock_rate" writable="1">
- <doc xml:space="preserve">default clock rate, 0 = unknown/variable</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="encoding_parameters" writable="1">
- <doc xml:space="preserve">encoding parameters. For audio this is the number of
- channels. NULL = not applicable.</doc>
- <type name="utf8" c:type="const gchar*"/>
- </field>
- <field name="bitrate" writable="1">
- <doc xml:space="preserve">the bitrate of the media. 0 = unknown/variable.</doc>
- <type name="guint" c:type="guint"/>
- </field>
- <field name="_gst_reserved" readable="0" private="1">
- <array zero-terminated="0" c:type="gpointer" fixed-size="4">
- <type name="gpointer" c:type="gpointer"/>
- </array>
- </field>
- <function name="for_name" c:identifier="gst_rtp_payload_info_for_name">
- <doc xml:space="preserve">Get the #GstRTPPayloadInfo for @media and @encoding_name. This function is
- mostly used to get the default clock-rate and bandwidth for dynamic payload
- types specified with @media and @encoding name.
- The search for @encoding_name will be performed in a case insensitve way.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPPayloadInfo or NULL when no info could be found.</doc>
- <type name="RTPPayloadInfo" c:type="const GstRTPPayloadInfo*"/>
- </return-value>
- <parameters>
- <parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve">the media to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="encoding_name" transfer-ownership="none">
- <doc xml:space="preserve">the encoding name to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="for_pt" c:identifier="gst_rtp_payload_info_for_pt">
- <doc xml:space="preserve">Get the #GstRTPPayloadInfo for @payload_type. This function is
- mostly used to get the default clock-rate and bandwidth for static payload
- types specified with @payload_type.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPPayloadInfo or NULL when no info could be found.</doc>
- <type name="RTPPayloadInfo" c:type="const GstRTPPayloadInfo*"/>
- </return-value>
- <parameters>
- <parameter name="payload_type" transfer-ownership="none">
- <doc xml:space="preserve">the payload_type to find</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- </record>
- <enumeration name="RTPProfile"
- version="1.6"
- glib:type-name="GstRTPProfile"
- glib:get-type="gst_rtp_profile_get_type"
- c:type="GstRTPProfile">
- <doc xml:space="preserve">The transfer profile to use.</doc>
- <member name="unknown"
- value="0"
- c:identifier="GST_RTP_PROFILE_UNKNOWN"
- glib:nick="unknown">
- <doc xml:space="preserve">invalid profile</doc>
- </member>
- <member name="avp"
- value="1"
- c:identifier="GST_RTP_PROFILE_AVP"
- glib:nick="avp">
- <doc xml:space="preserve">the Audio/Visual profile (RFC 3551)</doc>
- </member>
- <member name="savp"
- value="2"
- c:identifier="GST_RTP_PROFILE_SAVP"
- glib:nick="savp">
- <doc xml:space="preserve">the secure Audio/Visual profile (RFC 3711)</doc>
- </member>
- <member name="avpf"
- value="3"
- c:identifier="GST_RTP_PROFILE_AVPF"
- glib:nick="avpf">
- <doc xml:space="preserve">the Audio/Visual profile with feedback (RFC 4585)</doc>
- </member>
- <member name="savpf"
- value="4"
- c:identifier="GST_RTP_PROFILE_SAVPF"
- glib:nick="savpf">
- <doc xml:space="preserve">the secure Audio/Visual profile with feedback (RFC 5124)</doc>
- </member>
- </enumeration>
- <constant name="RTP_HDREXT_BASE"
- value="urn:ietf:params:rtp-hdrext:"
- c:type="GST_RTP_HDREXT_BASE">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_HDREXT_NTP_56"
- value="ntp-56"
- c:type="GST_RTP_HDREXT_NTP_56">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_HDREXT_NTP_56_SIZE"
- value="7"
- c:type="GST_RTP_HDREXT_NTP_56_SIZE">
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_HDREXT_NTP_64"
- value="ntp-64"
- c:type="GST_RTP_HDREXT_NTP_64">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_HDREXT_NTP_64_SIZE"
- value="8"
- c:type="GST_RTP_HDREXT_NTP_64_SIZE">
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_PAYLOAD_1016_STRING"
- value="1"
- c:type="GST_RTP_PAYLOAD_1016_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_CELLB_STRING"
- value="25"
- c:type="GST_RTP_PAYLOAD_CELLB_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_CN_STRING"
- value="13"
- c:type="GST_RTP_PAYLOAD_CN_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_DVI4_11025_STRING"
- value="16"
- c:type="GST_RTP_PAYLOAD_DVI4_11025_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_DVI4_16000_STRING"
- value="6"
- c:type="GST_RTP_PAYLOAD_DVI4_16000_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_DVI4_22050_STRING"
- value="17"
- c:type="GST_RTP_PAYLOAD_DVI4_22050_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_DVI4_8000_STRING"
- value="5"
- c:type="GST_RTP_PAYLOAD_DVI4_8000_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_DYNAMIC_STRING"
- value="[96, 127]"
- c:type="GST_RTP_PAYLOAD_DYNAMIC_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G721_STRING"
- value="2"
- c:type="GST_RTP_PAYLOAD_G721_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G722_STRING"
- value="9"
- c:type="GST_RTP_PAYLOAD_G722_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G723_53"
- value="17"
- c:type="GST_RTP_PAYLOAD_G723_53">
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_PAYLOAD_G723_53_STRING"
- value="17"
- c:type="GST_RTP_PAYLOAD_G723_53_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G723_63"
- value="16"
- c:type="GST_RTP_PAYLOAD_G723_63">
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_PAYLOAD_G723_63_STRING"
- value="16"
- c:type="GST_RTP_PAYLOAD_G723_63_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G723_STRING"
- value="4"
- c:type="GST_RTP_PAYLOAD_G723_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G728_STRING"
- value="15"
- c:type="GST_RTP_PAYLOAD_G728_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_G729_STRING"
- value="18"
- c:type="GST_RTP_PAYLOAD_G729_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_GSM_STRING"
- value="3"
- c:type="GST_RTP_PAYLOAD_GSM_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_H261_STRING"
- value="31"
- c:type="GST_RTP_PAYLOAD_H261_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_H263_STRING"
- value="34"
- c:type="GST_RTP_PAYLOAD_H263_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_JPEG_STRING"
- value="26"
- c:type="GST_RTP_PAYLOAD_JPEG_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_L16_MONO_STRING"
- value="11"
- c:type="GST_RTP_PAYLOAD_L16_MONO_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_L16_STEREO_STRING"
- value="10"
- c:type="GST_RTP_PAYLOAD_L16_STEREO_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_LPC_STRING"
- value="7"
- c:type="GST_RTP_PAYLOAD_LPC_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_MP2T_STRING"
- value="33"
- c:type="GST_RTP_PAYLOAD_MP2T_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_MPA_STRING"
- value="14"
- c:type="GST_RTP_PAYLOAD_MPA_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_MPV_STRING"
- value="32"
- c:type="GST_RTP_PAYLOAD_MPV_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_NV_STRING"
- value="28"
- c:type="GST_RTP_PAYLOAD_NV_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_PCMA_STRING"
- value="8"
- c:type="GST_RTP_PAYLOAD_PCMA_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_PCMU_STRING"
- value="0"
- c:type="GST_RTP_PAYLOAD_PCMU_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_QCELP_STRING"
- value="12"
- c:type="GST_RTP_PAYLOAD_QCELP_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_TS41" value="19" c:type="GST_RTP_PAYLOAD_TS41">
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_PAYLOAD_TS41_STRING"
- value="19"
- c:type="GST_RTP_PAYLOAD_TS41_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_PAYLOAD_TS48" value="18" c:type="GST_RTP_PAYLOAD_TS48">
- <type name="gint" c:type="gint"/>
- </constant>
- <constant name="RTP_PAYLOAD_TS48_STRING"
- value="18"
- c:type="GST_RTP_PAYLOAD_TS48_STRING">
- <type name="utf8" c:type="gchar*"/>
- </constant>
- <constant name="RTP_VERSION" value="2" c:type="GST_RTP_VERSION">
- <doc xml:space="preserve">The supported RTP version 2.</doc>
- <type name="gint" c:type="gint"/>
- </constant>
- <function name="rtcp_buffer_map"
- c:identifier="gst_rtcp_buffer_map"
- moved-to="RTCPBuffer.map">
- <doc xml:space="preserve">Open @buffer for reading or writing, depending on @flags. The resulting RTCP
- buffer state is stored in @rtcp.</doc>
- <return-value transfer-ownership="none">
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">a buffer with an RTCP packet</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve">flags for the mapping</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- <parameter name="rtcp" transfer-ownership="none">
- <doc xml:space="preserve">resulting #GstRTCPBuffer</doc>
- <type name="RTCPBuffer" c:type="GstRTCPBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_new"
- c:identifier="gst_rtcp_buffer_new"
- moved-to="RTCPBuffer.new">
- <doc xml:space="preserve">Create a new buffer for constructing RTCP packets. The packet will have a
- maximum size of @mtu.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="mtu" transfer-ownership="none">
- <doc xml:space="preserve">the maximum mtu size.</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_new_copy_data"
- c:identifier="gst_rtcp_buffer_new_copy_data"
- moved-to="RTCPBuffer.new_copy_data">
- <doc xml:space="preserve">Create a new buffer and set the data to a copy of @len
- bytes of @data and the size to @len. The data will be freed when the buffer
- is freed.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer with a copy of @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_new_take_data"
- c:identifier="gst_rtcp_buffer_new_take_data"
- moved-to="RTCPBuffer.new_take_data">
- <doc xml:space="preserve">Create a new buffer and set the data and size of the buffer to @data and @len
- respectively. @data will be freed when the buffer is unreffed, so this
- function transfers ownership of @data to the new buffer.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer with @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_validate"
- c:identifier="gst_rtcp_buffer_validate"
- moved-to="RTCPBuffer.validate">
- <doc xml:space="preserve">Check if the data pointed to by @buffer is a valid RTCP packet using
- gst_rtcp_buffer_validate_data().</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @buffer is a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">the buffer to validate</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_validate_data"
- c:identifier="gst_rtcp_buffer_validate_data"
- moved-to="RTCPBuffer.validate_data">
- <doc xml:space="preserve">Check if the @data and @size point to the data of a valid compound,
- non-reduced size RTCP packet.
- Use this function to validate a packet before using the other functions in
- this module.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if the data points to a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">the data to validate</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of @data to validate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_validate_data_reduced"
- c:identifier="gst_rtcp_buffer_validate_data_reduced"
- moved-to="RTCPBuffer.validate_data_reduced"
- version="1.6">
- <doc xml:space="preserve">Check if the @data and @size point to the data of a valid RTCP packet.
- Use this function to validate a packet before using the other functions in
- this module.
- This function is updated to support reduced size rtcp packets according to
- RFC 5506 and will validate full compound RTCP packets as well as reduced
- size RTCP packets.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if the data points to a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">the data to validate</doc>
- <array length="1" zero-terminated="0" c:type="guint8*">
- <type name="guint8" c:type="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of @data to validate</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_buffer_validate_reduced"
- c:identifier="gst_rtcp_buffer_validate_reduced"
- moved-to="RTCPBuffer.validate_reduced"
- version="1.6">
- <doc xml:space="preserve">Check if the data pointed to by @buffer is a valid RTCP packet using
- gst_rtcp_buffer_validate_reduced().</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">TRUE if @buffer is a valid RTCP packet.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">the buffer to validate</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_ntp_to_unix" c:identifier="gst_rtcp_ntp_to_unix">
- <doc xml:space="preserve">Converts an NTP time to UNIX nanoseconds. @ntptime can typically be
- the NTP time of an SR RTCP message and contains, in the upper 32 bits, the
- number of seconds since 1900 and, in the lower 32 bits, the fractional
- seconds. The resulting value will be the number of nanoseconds since 1970.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the UNIX time for @ntptime in nanoseconds.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="ntptime" transfer-ownership="none">
- <doc xml:space="preserve">an NTP timestamp</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_sdes_name_to_type"
- c:identifier="gst_rtcp_sdes_name_to_type">
- <doc xml:space="preserve">Convert @name into a @GstRTCPSDESType. @name is typically a key in a
- #GstStructure containing SDES items.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the #GstRTCPSDESType for @name or #GST_RTCP_SDES_PRIV when @name
- is a private sdes item.</doc>
- <type name="RTCPSDESType" c:type="GstRTCPSDESType"/>
- </return-value>
- <parameters>
- <parameter name="name" transfer-ownership="none">
- <doc xml:space="preserve">a SDES name</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_sdes_type_to_name"
- c:identifier="gst_rtcp_sdes_type_to_name">
- <doc xml:space="preserve">Converts @type to the string equivalent. The string is typically used as a
- key in a #GstStructure containing SDES items.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the string equivalent of @type</doc>
- <type name="utf8" c:type="const gchar*"/>
- </return-value>
- <parameters>
- <parameter name="type" transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTCPSDESType</doc>
- <type name="RTCPSDESType" c:type="GstRTCPSDESType"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtcp_unix_to_ntp" c:identifier="gst_rtcp_unix_to_ntp">
- <doc xml:space="preserve">Converts a UNIX timestamp in nanoseconds to an NTP time. The caller should
- pass a value with nanoseconds since 1970. The NTP time will, in the upper
- 32 bits, contain the number of seconds since 1900 and, in the lower 32
- bits, the fractional seconds. The resulting value can be used as an ntptime
- for constructing SR RTCP packets.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the NTP time for @unixtime.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="unixtime" transfer-ownership="none">
- <doc xml:space="preserve">an UNIX timestamp in nanoseconds</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_allocate_data"
- c:identifier="gst_rtp_buffer_allocate_data"
- moved-to="RTPBuffer.allocate_data">
- <doc xml:space="preserve">Allocate enough data in @buffer to hold an RTP packet with @csrc_count CSRCs,
- a payload length of @payload_len and padding of @pad_len.
- @buffer must be writable and all previous memory in @buffer will be freed.
- If @pad_len is >0, the padding bit will be set. All other RTP header fields
- will be set to 0/FALSE.</doc>
- <return-value transfer-ownership="none">
- <type name="none" c:type="void"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_calc_header_len"
- c:identifier="gst_rtp_buffer_calc_header_len"
- moved-to="RTPBuffer.calc_header_len">
- <doc xml:space="preserve">Calculate the header length of an RTP packet with @csrc_count CSRC entries.
- An RTP packet can have at most 15 CSRC entries.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The length of an RTP header with @csrc_count CSRC entries.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_calc_packet_len"
- c:identifier="gst_rtp_buffer_calc_packet_len"
- moved-to="RTPBuffer.calc_packet_len">
- <doc xml:space="preserve">Calculate the total length of an RTP packet with a payload size of @payload_len,
- a padding of @pad_len and a @csrc_count CSRC entries.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The total length of an RTP header with given parameters.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_calc_payload_len"
- c:identifier="gst_rtp_buffer_calc_payload_len"
- moved-to="RTPBuffer.calc_payload_len">
- <doc xml:space="preserve">Calculate the length of the payload of an RTP packet with size @packet_len,
- a padding of @pad_len and a @csrc_count CSRC entries.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The length of the payload of an RTP packet with given parameters.</doc>
- <type name="guint" c:type="guint"/>
- </return-value>
- <parameters>
- <parameter name="packet_len" transfer-ownership="none">
- <doc xml:space="preserve">the length of the total RTP packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_compare_seqnum"
- c:identifier="gst_rtp_buffer_compare_seqnum"
- moved-to="RTPBuffer.compare_seqnum">
- <doc xml:space="preserve">Compare two sequence numbers, taking care of wraparounds. This function
- returns the difference between @seqnum1 and @seqnum2.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a negative value if @seqnum1 is bigger than @seqnum2, 0 if they
- are equal or a positive value if @seqnum1 is smaller than @segnum2.</doc>
- <type name="gint" c:type="gint"/>
- </return-value>
- <parameters>
- <parameter name="seqnum1" transfer-ownership="none">
- <doc xml:space="preserve">a sequence number</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- <parameter name="seqnum2" transfer-ownership="none">
- <doc xml:space="preserve">a sequence number</doc>
- <type name="guint16" c:type="guint16"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_default_clock_rate"
- c:identifier="gst_rtp_buffer_default_clock_rate"
- moved-to="RTPBuffer.default_clock_rate">
- <doc xml:space="preserve">Get the default clock-rate for the static payload type @payload_type.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">the default clock rate or -1 if the payload type is not static or
- the clock-rate is undefined.</doc>
- <type name="guint32" c:type="guint32"/>
- </return-value>
- <parameters>
- <parameter name="payload_type" transfer-ownership="none">
- <doc xml:space="preserve">the static payload type</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_ext_timestamp"
- c:identifier="gst_rtp_buffer_ext_timestamp"
- moved-to="RTPBuffer.ext_timestamp">
- <doc xml:space="preserve">Update the @exttimestamp field with @timestamp. For the first call of the
- method, @exttimestamp should point to a location with a value of -1.
- This function makes sure that the returned value is a constantly increasing
- value even in the case where there is a timestamp wraparound.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">The extended timestamp of @timestamp.</doc>
- <type name="guint64" c:type="guint64"/>
- </return-value>
- <parameters>
- <parameter name="exttimestamp" transfer-ownership="none">
- <doc xml:space="preserve">a previous extended timestamp</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- <parameter name="timestamp" transfer-ownership="none">
- <doc xml:space="preserve">a new timestamp</doc>
- <type name="guint32" c:type="guint32"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_map"
- c:identifier="gst_rtp_buffer_map"
- moved-to="RTPBuffer.map">
- <doc xml:space="preserve">Map the contents of @buffer into @rtp.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE if @buffer could be mapped.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="buffer" transfer-ownership="none">
- <doc xml:space="preserve">a #GstBuffer</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </parameter>
- <parameter name="flags" transfer-ownership="none">
- <doc xml:space="preserve">#GstMapFlags</doc>
- <type name="Gst.MapFlags" c:type="GstMapFlags"/>
- </parameter>
- <parameter name="rtp"
- direction="out"
- caller-allocates="1"
- transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPBuffer</doc>
- <type name="RTPBuffer" c:type="GstRTPBuffer*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_new_allocate"
- c:identifier="gst_rtp_buffer_new_allocate"
- moved-to="RTPBuffer.new_allocate">
- <doc xml:space="preserve">Allocate a new #GstBuffer with enough data to hold an RTP packet with
- @csrc_count CSRCs, a payload length of @payload_len and padding of @pad_len.
- All other RTP header fields will be set to 0/FALSE.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer that can hold an RTP packet with given
- parameters.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="payload_len" transfer-ownership="none">
- <doc xml:space="preserve">the length of the payload</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_new_allocate_len"
- c:identifier="gst_rtp_buffer_new_allocate_len"
- moved-to="RTPBuffer.new_allocate_len">
- <doc xml:space="preserve">Create a new #GstBuffer that can hold an RTP packet that is exactly
- @packet_len long. The length of the payload depends on @pad_len and
- @csrc_count and can be calculated with gst_rtp_buffer_calc_payload_len().
- All RTP header fields will be set to 0/FALSE.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer that can hold an RTP packet of @packet_len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="packet_len" transfer-ownership="none">
- <doc xml:space="preserve">the total length of the packet</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="pad_len" transfer-ownership="none">
- <doc xml:space="preserve">the amount of padding</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- <parameter name="csrc_count" transfer-ownership="none">
- <doc xml:space="preserve">the number of CSRC entries</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_new_copy_data"
- c:identifier="gst_rtp_buffer_new_copy_data"
- moved-to="RTPBuffer.new_copy_data">
- <doc xml:space="preserve">Create a new buffer and set the data to a copy of @len
- bytes of @data and the size to @len. The data will be freed when the buffer
- is freed.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer with a copy of @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="none">
- <doc xml:space="preserve">data for the new
- buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_buffer_new_take_data"
- c:identifier="gst_rtp_buffer_new_take_data"
- moved-to="RTPBuffer.new_take_data">
- <doc xml:space="preserve">Create a new buffer and set the data and size of the buffer to @data and @len
- respectively. @data will be freed when the buffer is unreffed, so this
- function transfers ownership of @data to the new buffer.</doc>
- <return-value transfer-ownership="full">
- <doc xml:space="preserve">A newly allocated buffer with @data and of size @len.</doc>
- <type name="Gst.Buffer" c:type="GstBuffer*"/>
- </return-value>
- <parameters>
- <parameter name="data" transfer-ownership="full">
- <doc xml:space="preserve">
- data for the new buffer</doc>
- <array length="1" zero-terminated="0" c:type="gpointer">
- <type name="guint8"/>
- </array>
- </parameter>
- <parameter name="len" transfer-ownership="none">
- <doc xml:space="preserve">the length of data</doc>
- <type name="gsize" c:type="gsize"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_hdrext_get_ntp_56"
- c:identifier="gst_rtp_hdrext_get_ntp_56">
- <doc xml:space="preserve">Reads the NTP time from the @size NTP-56 extension bytes in @data and store the
- result in @ntptime.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">the data to read from</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ntptime" transfer-ownership="none">
- <doc xml:space="preserve">the result NTP time</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_hdrext_get_ntp_64"
- c:identifier="gst_rtp_hdrext_get_ntp_64">
- <doc xml:space="preserve">Reads the NTP time from the @size NTP-64 extension bytes in @data and store the
- result in @ntptime.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">the data to read from</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ntptime" transfer-ownership="none">
- <doc xml:space="preserve">the result NTP time</doc>
- <type name="guint64" c:type="guint64*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_hdrext_set_ntp_56"
- c:identifier="gst_rtp_hdrext_set_ntp_56">
- <doc xml:space="preserve">Writes the NTP time in @ntptime to the format required for the NTP-56 header
- extension. @data must hold at least #GST_RTP_HDREXT_NTP_56_SIZE bytes.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">the data to write to</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ntptime" transfer-ownership="none">
- <doc xml:space="preserve">the NTP time</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_hdrext_set_ntp_64"
- c:identifier="gst_rtp_hdrext_set_ntp_64">
- <doc xml:space="preserve">Writes the NTP time in @ntptime to the format required for the NTP-64 header
- extension. @data must hold at least #GST_RTP_HDREXT_NTP_64_SIZE bytes.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">%TRUE on success.</doc>
- <type name="gboolean" c:type="gboolean"/>
- </return-value>
- <parameters>
- <parameter name="data"
- transfer-ownership="none"
- nullable="1"
- allow-none="1">
- <doc xml:space="preserve">the data to write to</doc>
- <type name="gpointer" c:type="gpointer"/>
- </parameter>
- <parameter name="size" transfer-ownership="none">
- <doc xml:space="preserve">the size of @data</doc>
- <type name="guint" c:type="guint"/>
- </parameter>
- <parameter name="ntptime" transfer-ownership="none">
- <doc xml:space="preserve">the NTP time</doc>
- <type name="guint64" c:type="guint64"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_payload_info_for_name"
- c:identifier="gst_rtp_payload_info_for_name"
- moved-to="RTPPayloadInfo.for_name">
- <doc xml:space="preserve">Get the #GstRTPPayloadInfo for @media and @encoding_name. This function is
- mostly used to get the default clock-rate and bandwidth for dynamic payload
- types specified with @media and @encoding name.
- The search for @encoding_name will be performed in a case insensitve way.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPPayloadInfo or NULL when no info could be found.</doc>
- <type name="RTPPayloadInfo" c:type="const GstRTPPayloadInfo*"/>
- </return-value>
- <parameters>
- <parameter name="media" transfer-ownership="none">
- <doc xml:space="preserve">the media to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- <parameter name="encoding_name" transfer-ownership="none">
- <doc xml:space="preserve">the encoding name to find</doc>
- <type name="utf8" c:type="const gchar*"/>
- </parameter>
- </parameters>
- </function>
- <function name="rtp_payload_info_for_pt"
- c:identifier="gst_rtp_payload_info_for_pt"
- moved-to="RTPPayloadInfo.for_pt">
- <doc xml:space="preserve">Get the #GstRTPPayloadInfo for @payload_type. This function is
- mostly used to get the default clock-rate and bandwidth for static payload
- types specified with @payload_type.</doc>
- <return-value transfer-ownership="none">
- <doc xml:space="preserve">a #GstRTPPayloadInfo or NULL when no info could be found.</doc>
- <type name="RTPPayloadInfo" c:type="const GstRTPPayloadInfo*"/>
- </return-value>
- <parameters>
- <parameter name="payload_type" transfer-ownership="none">
- <doc xml:space="preserve">the payload_type to find</doc>
- <type name="guint8" c:type="guint8"/>
- </parameter>
- </parameters>
- </function>
- </namespace>
- </repository>
|